Signals Docs
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

EventWhen it is sent
automation.call.initiatedSignals starts dialling. Sent once per attempt.
automation.call.ringingThe customer's phone is ringing. Sent once per attempt.
automation.call.answeredThe customer answers. Sent once per attempt.
automation.call.completedThe run has finished, after any retries. Sent once per run.

Fields

Each event carries the run. The most useful fields are:

FieldDescription
run_id, automation_id, event_idThe run, its automation and the event_id of its trigger.
attemptThe attempt number, which increases with each retry.
to_number, caller_numberThe number called and the originating number the customer saw.
status, outcome, suppression_reasonThe state of the run. Only automation.call.completed carries outcome.
pressedThe key the customer pressed, with its key, label and outcome_value, or null if no key was pressed.
answered_at, ended_at, duration_secondsWhen the call was answered and ended, and how long it lasted.
next_attempt_atWhen the next retry is scheduled, if there is one.
metadataThe 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