- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
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 |
Required. The integration resource name. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "triggerId": string, "parameters": { object ( |
Fields | |
---|---|
triggerId |
Required. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(triggerId). The triggerId is in the format of |
parameters |
Optional. Passed in as parameters to each integration execution. Redacted |
doNotPropagateError |
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. |
parameterEntries[] |
Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. |
requestId |
Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned. |
executionId |
Optional. The id of the ON_HOLD execution to be resumed. |
inputParameters |
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.