sincecutoff.com
← all changes

Stripe Workflows API supports programmatic invocation and run monitoring

Introduced 2026-04-22 · score 0.95

HOW TO USE IT

For a Dashboard-created Workflow with an on-demand trigger, call the v2 API to list or retrieve it and invoke it with `input_parameters`; monitor runs by listing or retrieving runs and subscribing to their lifecycle events.

curl 'https://api.stripe.com/v2/extend/workflows' -H 'Authorization: Bearer <YOUR_SECRET_KEY>' -H 'Stripe-Version: 2026-04-22.preview'
curl -X POST 'https://api.stripe.com/v2/extend/workflows/<WORKFLOW_ID>/invoke' -H 'Authorization: Bearer <YOUR_SECRET_KEY>' -H 'Stripe-Version: 2026-04-22.preview' --json '{"input_parameters":{"<PARAMETER_NAME>":"<VALUE>"}}'
curl 'https://api.stripe.com/v2/extend/workflow_runs' -H 'Authorization: Bearer <YOUR_SECRET_KEY>' -H 'Stripe-Version: 2026-04-22.preview'

WHY THIS HELPS

Integrate Dashboard-created Stripe Workflows into application logic and monitor their runs.

BEFORE THIS CHANGE

Workflows could only be triggered by Stripe events.

REQUIREMENTS AND LIMITATIONS

  • Availability: The linked API references use API version 2026-04-22.preview.
  • Authorization: Bearer <YOUR_SECRET_KEY> (required): Authenticates the API request with your Stripe secret key.
  • Stripe-Version: 2026-04-22.preview (required): Sets the API version used in the documented request.
  • <WORKFLOW_ID> (required): Workflow ID in the retrieve or invoke URL.
  • input_parameters (required): Map of parameters used to invoke the Workflow Run.
  • limit: Maximum page size for listing Workflows or Workflow Runs.
  • page: Current page token for list requests.
  • status: List filter: Workflow status values are active, archived, draft, inactive; Run status values are failed, started, succeeded. Values are not documented as mutually exclusive.
  • workflow: List filter for Workflow Runs associated with specified Workflow IDs.
  • Prerequisite: Workflows to invoke must have an on-demand trigger; the API reports `workflow_not_invokable` otherwise.
  • Prerequisite: The invoke reference lists creating a customer first as a prerequisite for its example request.
  • Prerequisite: Workflow run event payloads are unversioned; during processing, fetch the versioned event from the API or fetch the resource’s current state.
  • The workflows are created through the Dashboard.

FIRST-PARTY EVIDENCE

Check the installed version and the source before using it. Entry JSON

Report a problem with this card