Skip to navigation

Webhook: Proactive call queued

A webhook sent when a request to call a person with a Proactive is accepted and queued

Payload

The payload of this webhook request is an object.
typeenumOptional

The webhook event type. Each state of a Proactive call is its own type; the payload shape is the same for all five.

Allowed values:
timestampstringOptional

When the attempt reached the state, as an ISO 8601 date-time with a UTC offset. Fractional seconds are present only when the stored time has them.

dataobjectOptional
The Proactive Attempt

Response

200
any
Return a 200 status to indicate that the data was received successfully.