API trigger

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

You can set the request and response payload for the API trigger by creating variables in your integration. For information about how to trigger an integration to perform CRUD operations on a MySQL database, see the Get started with Apigee Integration and MySQL connection tutorial.

Add an API trigger

To add an API trigger trigger, perform the following steps:
  1. In the Apigee UI, select your Apigee Organization.
  2. Click Develop > Integrations.
  3. Select an existing integration or create a new integration by clicking Create Integration.

    If you are creating a new integration:

    1. Enter a name and description in the Create Integration dialog.
    2. Select a Region for the integration from the list of supported regions.
    3. Click Create.

    This opens the integration in the integration designer.

  4. In the integration designer navigation bar, click +Add a task/trigger > Triggers to view the list of available triggers.
  5. Click and place the API trigger element to the designer.

Configure an API trigger

Click the API trigger element in the integration editor 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.

Considerations

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.