Configure an API Trigger

You're viewing Apigee X documentation.
View Apigee Edge documentation.

API Triggers are used to directly invoke executions for integrations. API Triggers can be used in synchronous or asynchronous mode.

Add an API Trigger

To add an API Trigger to a new or existing integration, follow the steps below:
  1. Go to the Apigee UI and sign in.
  2. Select your organization using the drop-down menu in the upper left corner of the UI.
  3. Click Develop > Integrations to view the list of available integrations.

  4. Select an existing integration or click Create new
  5. In the integration designer, click + Add a task/trigger to view the task and trigger selection dialog.
  6. Click Triggers to view the available triggers.
  7. Drag the API Trigger element to the designer.

Configure an API Trigger

Click the API Trigger element in the integration designer to view the trigger configuration pane.

The configuration panel displays the Trigger ID, which is a machine-generated ID in the format api_trigger/TRIGGER_NAME. No further configuration is required for this trigger.


When using the API trigger, the cumulative size of all the input variables can be a maximum of 8 MB. If the size exceeds 8 MB, Apigee doesn't run the integration and you will get an error.