Submit an Event

Delivers an external event to a workflow instance that is waiting on a wait_event step. When the event matches a step the instance is waiting for, the instance resumes execution from that step. This endpoint is idempotent: submitting the same event again after it was already processed returns status already_processed instead of resuming the workflow twice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The workflow instance ID that is waiting for the event.

Body Params
string
required

Name of the event the instance is waiting for. Must match the wait_event step's configured event name.

payload
object

Arbitrary JSON data to pass into the workflow with the event. Maximum serialized size is 64 KB. If the waiting step declares a payload_schema, the payload is validated against it.

Headers
string
required

Your organization ID. Must match the organization that owns the secret key.

Responses

400

Bad request.

403

Livemode mismatch.

404

Instance or wait state not found.

409

The waiting step can no longer receive events.

422

The matched step is not waiting.

500

Unexpected server error.

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json