API Gateway Triggers: Adding and Setting

This trigger, in contrast to the others, executes the flow in conjunction with an API Gateway configured within the platform.

Learn how to add and configure an API Gateway Trigger below:

Add API Gateway Trigger

To add an API Gateway trigger, follow these steps:

  1. Click on "Start with a trigger".

  2. Click on the plus sign of the "API Gateway" option. You will then open the modal to configure it and view more information.

  3. This modal is divided into two areas: Header and Settings.

Find out about the Module Header here.

Settings

Select the API Gateway, Version and Route fields previously registered.

It is not possible to use the same route in more than one API Gateway Trigger.

In addition, the settings screen has more items:

  • Trigger URL: After selecting the previous settings, the Trigger URL will be displayed.

  • OAuth2 Token URL: This field is shown for OAuth2 types and allows generating the OAuth2 token. To do so, make a POST request to the displayed URL using the provided request example. Read more.

  • Use JSON Schema in the request (optional): Enables you to send a JSON Schema for validation by the API Gateway.

  • Request Specification: The Body and Query fields are optional.

The BODY and QUERY data entered here will appear, respectively, as the body and query parameters of the API Gateway Trigger in the configuration of subsequent modules.

To finalize the trigger settings, click on "Save".

Read also:

PreviousTriggers of a flowNextAS2 Triggers: Adding and Setting

Last updated