Skip to content

WorkflowTarget

An EZGH Workflows workflow in the queue's project: each message starts a run, its input the message ({messageId, body, attributes, sentAt, queueId, groupId?, seq?}); the message is acknowledged once the start is accepted, and a redelivered message reaches the run its first delivery started. One message per call (batchSize 1); on a FIFO queue a group's next message waits for the previous start. Configuring it needs queues.subscriptions.create (or update) and workflows.runs.start (resume: workflows.runs.resume) on the workflow (<app's resourceName>/). No signing secret.

Fields

  • appIdstringrequired

    The Workflows app's id (wfa_), in the queue's project.

    format: uuid
  • kindunknownrequired
  • modestartorresumerequired

    start: each message starts a run. resume: each message completes the waits (step.waitForMessage) of the app's runs waiting on its correlationAttribute's value, acked once any resumed; with none waiting yet, or without the attribute, it's retried with the backoff and then dead-lettered. Clients treat other modes as unknown.

  • workflowstringrequired

    One of the app's workflows.

    pattern: ^[A-Za-z0-9_-]{1,64}$
  • correlationAttributeoptionalstring

    resume only, and required for it: the message attribute whose value (1-256 letters, digits and _ . : -) is the waits' key.

    pattern: ^[A-Za-z0-9_.-]{1,64}$
Navigation

Type to search…

↑↓ navigate↵ selectEsc close