Skip to content

Workflows (Execution)

Once a transaction for an app is started, workflows that are registered with this app can be started using the transactions/{transactionId}/workflows POST endpoint.

The documentation for the registration of workflows can be found here.

How to start a workflow?

To start a workflow for a specific transaction, use the transactions/ {transactionId}/workflows POST endpoint. You need to provide the transaction ID in the URL and the workflow definition ID in the request body.

How to get workflow status?

To retrieve the metadata and current status of a specific workflow run, use the transactions/{transactionId}/workflows/{workflowRunId} GET endpoint.

Authorization

Access to the following endpoints is restricted (besides being an authenticated client):

POST

  • client needs transaction:write scope
  • no specific participant rules apply

GET

  • client needs transaction:write scope
  • no specific participant rules apply