CustomSuspensionRequest

JSON representation
{
  "suspensionInfoEventParameterKey": string,
  "postToQueueWithTriggerIdRequest": {
    object (PostToQueueWithTriggerIdRequest)
  }
}
Fields
suspensionInfoEventParameterKey

string

In the fired event, set the SuspensionInfo message as the value for this key.

postToQueueWithTriggerIdRequest

object (PostToQueueWithTriggerIdRequest)

Request to fire an event containing the SuspensionInfo message.

PostToQueueWithTriggerIdRequest

Use this request to post all workflows associated with a given trigger id. Next available id: 10

JSON representation
{
  "triggerId": string,
  "clientId": string,
  "parameters": {
    object (EventParameters)
  },
  "priority": enum (Priority),
  "testMode": boolean,
  "scheduledTime": string,
  "ignoreErrorIfNoActiveWorkflow": boolean,
  "workflowName": string,
  "requestId": string
}
Fields
triggerId

string

Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(triggerId) Required.

clientId

string

Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients.

parameters

object (EventParameters)

Passed in as parameters to each workflow execution. Optional.

priority

enum (Priority)

The request priority this request should be processed at.

For internal users:

testMode

boolean

Optional. Sets test mode in {@link enterprise/crm/eventbus/eventMessage.proto}.

scheduledTime

string (int64 format)

Optional. Time in milliseconds since epoch when the given event would be scheduled.

ignoreErrorIfNoActiveWorkflow

boolean

Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested triggerId or clientId is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default.

workflowName

string

Optional. If provided, the workflowName is used to filter all the matched workflows having same triggerId+clientId. A combination of triggerId, clientId and workflowName identifies a unique workflow.

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. Must have no more than 36 characters and contain only alphanumeric characters and hyphens.