Method: projects.locations.integrations.execute

Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing -), all of the associated integration under the given triggerId will be executed. Otherwise only the specified integration for the given triggerId is executed. This is helpful for execution the integration from UI.

HTTP request

POST https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The integration resource name.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "triggerId": string,
  "doNotPropagateError": boolean,
  "requestId": string,
  "executionId": string,
  "inputParameters": {
    string: {
      object (ValueType)
    },
    ...
  }
}
Fields
triggerId

string

Required. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(triggerId). The triggerId is in the format of api_trigger/TRIGGER_NAME.
doNotPropagateError

boolean

Optional. Flag to determine how to should propagate errors. If this flag is set to be true, it will not throw an exception. Instead, it will return a {@link ExecuteIntegrationsResponse} with an execution id and error messages as PostWithTriggerIdExecutionException in {@link EventParameters}. The flag is set to be false by default.
requestId

string

Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
executionId

string

Optional. The id of the ON_HOLD execution to be resumed.
inputParameters

map (key: string, value: object (ValueType))

Optional. Input parameters used by integration execution.

Response body

If successful, the response body contains an instance of ExecuteIntegrationsResponse.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • integrations.integrations.invoke

For more information, see the IAM documentation.