Automations
Webhook events
Signals reports the progress of each run to your webhook endpoints. Subscribe an
endpoint to the events below, scoped either to your whole organization or to a single automation by
its sig_ id. Automation events are signed in the same way as every other Signals webhook.
Events
| Event | When it is sent |
|---|---|
automation.call.initiated | Signals starts dialling. Sent once per attempt. |
automation.call.ringing | The customer's phone is ringing. Sent once per attempt. |
automation.call.answered | The customer answers. Sent once per attempt. |
automation.call.completed | The run has finished, after any retries. Sent once per run. |
Fields
Each event carries the run. The most useful fields are:
| Field | Description |
|---|---|
run_id, automation_id, event_id | The run, its automation and the event_id of its trigger. |
attempt | The attempt number, which increases with each retry. |
to_number, caller_number | The number called and the originating number the customer saw. |
status, outcome, suppression_reason | The state of the run. Only automation.call.completed carries outcome. |
pressed | The key the customer pressed, with its key, label and outcome_value, or null if no key was pressed. |
answered_at, ended_at, duration_seconds | When the call was answered and ended, and how long it lasted. |
next_attempt_at | When the next retry is scheduled, if there is one. |
metadata | The metadata object you sent with the trigger. |
For the appointment reminder in Triggering calls, the completed
event for a patient who pressed 1 carries outcome set to completed and pressed.outcome_value
set to confirmed. Match it to your booking through event_id or the metadata you sent.
Last modified on