API Reference
Status PageRoadmapTestimoniesShare feedback

workflow_session.started

wbhk
workflow_session.started

This event is triggered when a Workflow Session reaches the ongoing status.

Payload
uuid
required

A unique identifier for this webhook event.

const
enum
required

The name of the webhook event that was triggered.

Allowed:
string
required

The timestamp (Unix epoch format) when the event occurred. It will stay constant even through retries.

uuid
required

The unique identifier of the webhook subscription that received this event.

string
required

Description of the webhook subscription.

boolean
required

A boolean indicating whether this event was triggered in a sandbox environment (true) or in production (false).

data
object
required

Contains detailed information about the Workflow Session that triggered this event.

Responses
2XX

Webhook received successfully.

3XX

Webhook redirected (max 2 allowed). Additional redirects will be ignored and delivery will be marked as failed.

4XX

Webhook delivery failed. Your server rejected the request.

Updated 6 months ago

Payload
Choose an example

Updated 6 months ago