Signals Docs
Signals API

Automations

Trigger an automation call for one customer, and cancel it before it is dialled. You build automations in the console. See Triggering calls.


Trigger an automation call

POST
https://api.signals.pressone.africa
/automations/{automation_id}/calls

Authenticated with an organization API key holding service_configuration:write; the project is the automation's. A revoked or expired key may keep working for up to 60 seconds.

Trigger an automation call › path Parameters

automation_id
​string · required

Automation id, sig_ prefixed

Trigger an automation call › Headers

Signals-Version
​string · enum · required

The supported API snapshot to use for this request.

Enum values:
2026-10-27

Trigger an automation call › Request Body

The trigger body; it is read as JSON and validated member by member.
phone_number
​string · pattern: ^\+[1-9][0-9]{6,14}$ · required

The number to call, in E.164.

event_id
​string | null · maxLength: 120

Your id for this request; a repeat answers the first run. One is made when omitted.

metadata
​object | null

Kept with the run as sent; at most 4096 bytes of JSON.

name
​string | null · maxLength: 120

The recipient's name, the template's {{name}}.

​object | null

Template values: at most 40, keyed ^[a-zA-Z][a-zA-Z0-9_]{0,63}$.

Trigger an automation call › Responses

A repeat of an earlier event_id; the first run as it is now.

A run as the trigger and cancel URLs answer it; `id` and `runId` are the same.
createdAt
​string · date-time · required
id
​string · required
​required
recipientNumber
​string · required
runId
​string · required
signalId
​string · required

The automation's id.

status
​AutomationRunStatus · enum · required
Enum values:
staged
queued
waiting_hours
scheduled
dialing
placed
ringing
answered
​required

Cancel a triggered automation call

POST
https://api.signals.pressone.africa
/automations/{automation_id}/calls/cancel

Authenticated with an organization API key holding service_configuration:write; the project is the automation's. A revoked or expired key may keep working for up to 60 seconds.

Cancel a triggered automation call › path Parameters

automation_id
​string · required

Automation id, sig_ prefixed

Cancel a triggered automation call › Headers

Signals-Version
​string · enum · required

The supported API snapshot to use for this request.

Enum values:
2026-10-27

Cancel a triggered automation call › Request Body

event_id
​string · maxLength: 120 · required

The event_id the run was triggered with.

Cancel a triggered automation call › Responses

The run: finished as no_longer_owed if it had not been dialed, else unchanged.

A run as the trigger and cancel URLs answer it; `id` and `runId` are the same.
createdAt
​string · date-time · required
id
​string · required
​required
recipientNumber
​string · required
runId
​string · required
signalId
​string · required

The automation's id.

status
​AutomationRunStatus · enum · required
Enum values:
staged
queued
waiting_hours
scheduled
dialing
placed
ringing
answered
​required