Preview

This product or feature is covered by the Pre-GA Offerings Terms of the Google Cloud Terms of Service. Pre-GA products and features might have limited support, and changes to pre-GA products and features might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

See the supported connectors for Application Integration.

API trigger

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 trigger, perform the following steps:

1. In the Google Cloud console, go to the Application Integration page.

   Go to Application Integration

   The Integrations List page appears.

2. 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.

3. In the integration designer navigation bar, click +Add a task/trigger > Triggers to view the list of available triggers.
4. Click and place 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.

Note: You can have more than one API trigger in your integration. Each API trigger is assigned a unique Trigger ID.

Invoke API trigger from an application

After you have published an integration that has an API trigger configured, you can use the integrations.execute method to invoke that trigger from any application.

Syntax

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -d '{"trigger_id":"api_trigger/TRIGGER_NAME"}' \
    "https://REGIONAL_SERVICE_ENDPOINT/v1/projects/PROJECT_ID/locations/-/integrations/-:execute"

Replace the following:

• TRIGGER_NAME: The name of the API trigger in your integration.
• REGIONAL_SERVICE_ENDPOINT: An Application Integration service endpoint. For information about the available Application Integration service endpoints, see Application Integration Service endpoints.
• PROJECT_ID: The ID of your Google Cloud project.

Example

The following example invokes an integration in us-east1 region containing the test_API_1 API trigger in the demo-project Google Cloud project:

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)"
    -H "Content-Type: application/json" \
    -d '{"trigger_id":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/-/integrations/-:execute"

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, Application Integration doesn't run the integration and you will get an error.