Skip to main content

Workflows

Manage and configure Workflows using Wrangler.

Note

The wrangler workflows command requires Wrangler version 3.83.0 or greater. Use npx wrangler@latest to always use the latest Wrangler version when invoking commands.

`--local` option

All wrangler workflows commands support the --local flag to target a Workflow running in a local wrangler dev session instead of production. Use --port to specify the port of the dev session (defaults to 8787).

The --local flag requires Wrangler version 4.79.0 or greater.

For more information, refer to Workflows local development.

workflows list

List Workflows associated to account

npx wrangler workflows list
yarn wrangler workflows list
pnpm wrangler workflows list

  • --local boolean

    Interact with local dev session

  • --port number default: 8787

    Port of the local dev session (default: 8787)

  • --json boolean default: false

    Output the raw API response as JSON

  • --page number default: 1

    Show a sepecific page from the listing, can configure page size using "per-page"

  • --per-page number

    Configure the maximum number of workflows to show per page

workflows describe

Describe Workflow resource

npx wrangler workflows describe <NAME>
yarn wrangler workflows describe <NAME>
pnpm wrangler workflows describe <NAME>

  • --local boolean

    Interact with local dev session

  • --port number default: 8787

    Port of the local dev session (default: 8787)

  • --json boolean default: false

    Output the raw API response as JSON

  • <NAME> string required

    Name of the workflow

workflows delete

Delete workflow - when deleting a workflow, it will also delete it's own instances

npx wrangler workflows delete <NAME>
yarn wrangler workflows delete <NAME>
pnpm wrangler workflows delete <NAME>

  • --local boolean

    Interact with local dev session

  • --port number default: 8787

    Port of the local dev session (default: 8787)

  • --json boolean default: false

    Output the raw API response as JSON

  • <NAME> string required

    Name of the workflow

workflows trigger

Trigger a workflow, creating a new instance. Can optionally take a JSON string to pass a parameter into the workflow instance

npx wrangler workflows trigger <NAME> [PARAMS]
yarn wrangler workflows trigger <NAME> [PARAMS]
pnpm wrangler workflows trigger <NAME> [PARAMS]

  • --local boolean

    Interact with local dev session

  • --port number default: 8787

    Port of the local dev session (default: 8787)

  • --json boolean default: false

    Output the raw API response as JSON

  • <NAME> string required

    Name of the workflow

  • [PARAMS] string default:

    Params for the workflow instance, encoded as a JSON string

  • --id string

    Custom instance ID, if not provided it will default to a random UUIDv4

workflows instances list

Instance related commands (list, describe, terminate, pause, resume)

npx wrangler workflows instances list <NAME>
yarn wrangler workflows instances list <NAME>
pnpm wrangler workflows instances list <NAME>

  • --local boolean

    Interact with local dev session

  • --port number default: 8787

    Port of the local dev session (default: 8787)

  • --json boolean default: false

    Output the raw API response as JSON

  • <NAME> string required

    Name of the workflow

  • --reverse boolean default: false

    Reverse order of the instances table

  • --status string

    Filters list by instance status (can be one of: queued, running, paused, errored, terminated, complete)

  • --date-start string

    Only list instances created at or after this date (ISO 8601, e.g. 2026-01-01 or 2026-01-01T13:00:00Z)

  • --date-end string

    Only list instances created at or before this date (ISO 8601). A date without a time covers the whole UTC day, so 2026-01-31 includes everything up to 2026-01-31T23:59:59.999Z

  • --page number default: 1

    Show a sepecific page from the listing, can configure page size using "per-page"

  • --per-page number

    Configure the maximum number of instances to show per page

workflows instances describe

Describe a workflow instance - see its logs, retries and errors

npx wrangler workflows instances describe <NAME> [ID]
yarn wrangler workflows instances describe <NAME> [ID]
pnpm wrangler workflows instances describe <NAME> [ID]

  • --local boolean

    Interact with local dev session

  • --port number default: 8787

    Port of the local dev session (default: 8787)

  • --json boolean default: false

    Output the raw API response as JSON

  • <NAME> string required

    Name of the workflow

  • [ID] string default: latest

    ID of the instance - instead of an UUID you can type 'latest' to get the latest instance and describe it

  • --step-output boolean default: true

    Don't output the step output since it might clutter the terminal

  • --truncate-output-limit number default: 5000

    Truncate step output after x characters

workflows instances send-event

Send an event to a workflow instance

npx wrangler workflows instances send-event <NAME> <ID>
yarn wrangler workflows instances send-event <NAME> <ID>
pnpm wrangler workflows instances send-event <NAME> <ID>

  • --local boolean

    Interact with local dev session

  • --port number default: 8787

    Port of the local dev session (default: 8787)

  • --json boolean default: false

    Output the raw API response as JSON

  • <NAME> string required

    Name of the workflow

  • <ID> string required

    ID of the instance - instead of an UUID you can type 'latest' to get the latest instance and send an event to it

  • --type string required

    Type of the workflow event

  • --payload string default: {}

    JSON string for the workflow event (e.g., '{"key": "value"}')

workflows instances terminate

Terminate a workflow instance

npx wrangler workflows instances terminate <NAME> <ID>
yarn wrangler workflows instances terminate <NAME> <ID>
pnpm wrangler workflows instances terminate <NAME> <ID>

  • --local boolean

    Interact with local dev session

  • --port number default: 8787

    Port of the local dev session (default: 8787)

  • --json boolean default: false

    Output the raw API response as JSON

  • <NAME> string required

    Name of the workflow

  • <ID> string required

    ID of the instance - instead of an UUID you can type 'latest' to get the latest instance and describe it

  • --rollback boolean default: false

    Run registered rollback handlers before terminating

workflows instances restart

Restart a workflow instance

npx wrangler workflows instances restart <NAME> <ID>
yarn wrangler workflows instances restart <NAME> <ID>
pnpm wrangler workflows instances restart <NAME> <ID>

  • --local boolean

    Interact with local dev session

  • --port number default: 8787

    Port of the local dev session (default: 8787)

  • --json boolean default: false

    Output the raw API response as JSON

  • <NAME> string required

    Name of the workflow

  • <ID> string required

    ID of the instance - instead of an UUID you can type 'latest' to get the latest instance and describe it

  • --from-step-name string

    Name of the step to restart from

  • --from-step-count number

    1-based occurrence of the step name/type to restart from (defaults to 1)

  • --from-step-type string

    Step type to restart from, used when the same name is shared across step types (defaults to do)

workflows instances pause

Pause a workflow instance

npx wrangler workflows instances pause <NAME> <ID>
yarn wrangler workflows instances pause <NAME> <ID>
pnpm wrangler workflows instances pause <NAME> <ID>

  • --local boolean

    Interact with local dev session

  • --port number default: 8787

    Port of the local dev session (default: 8787)

  • --json boolean default: false

    Output the raw API response as JSON

  • <NAME> string required

    Name of the workflow

  • <ID> string required

    ID of the instance - instead of an UUID you can type 'latest' to get the latest instance and pause it

workflows instances resume

Resume a workflow instance

npx wrangler workflows instances resume <NAME> <ID>
yarn wrangler workflows instances resume <NAME> <ID>
pnpm wrangler workflows instances resume <NAME> <ID>

  • --local boolean

    Interact with local dev session

  • --port number default: 8787

    Port of the local dev session (default: 8787)

  • --json boolean default: false

    Output the raw API response as JSON

  • <NAME> string required

    Name of the workflow

  • <ID> string required

    ID of the instance - instead of an UUID you can type 'latest' to get the latest instance and resume it

workflows instances delete

Delete workflow instances

npx wrangler workflows instances delete <NAME> [ID]
yarn wrangler workflows instances delete <NAME> [ID]
pnpm wrangler workflows instances delete <NAME> [ID]

  • --local boolean

    Interact with local dev session

  • --port number default: 8787

    Port of the local dev session (default: 8787)

  • --json boolean default: false

    Output the raw API response as JSON

  • <NAME> string required

    Name of the workflow

  • [ID] string

    IDs of the instances - you can type 'latest' to get the latest instance and delete it

  • --filename string

    Path to a JSON file containing an array of instance IDs

Edit on GitHub