Assistant triggers
What wakes an assistant: schedules, CRM events and inbound web hooks.
The trigger object
As returned by GET /triggers, one element of the list. Every endpoint below that returns this resource returns exactly these fields.
| Name | Type | Description |
|---|---|---|
idrequired | string (uuid) | Trigger id |
assistant_idrequired | string (uuid) | The assistant this fires |
namerequired | string | Trigger name |
enabledrequired | boolean | Triggers are created switched OFF; enable them explicitly |
kindrequired | string (enum) | What wakes the assistantrecurringonceeventwebhook |
goalrequired | string | What the assistant is asked to do when this fires |
periodrequired | string (enum) | null | Recurring triggers onlydailyweeklymonthly |
send_timerequired | string | null | Recurring only, as HH:MM in the account timezone |
day_of_weekrequired | integer | null | Recurring weekly, where 0 is Sunday |
day_of_monthrequired | integer | null | Recurring monthly, 1 to 31, clamped to the end of a short month |
run_atrequired | string (date-time) | null | One-off triggers only: when it fires |
event_keyrequired | string | null | Event triggers only: which event, from the catalogue |
audience_typerequired | string (enum) | Who a firing acts onnonecontactsegment |
contact_idrequired | string (uuid) | null | Set when the audience is a single contact |
segment_idrequired | string (uuid) | null | Set when the audience is a segment |
max_targetsrequired | integer | Ceiling on runs started per firing, 1 to 500 |
respect_quiet_hoursrequired | boolean | Defer a firing that lands outside the account sending hours |
last_fired_atrequired | string (date-time) | null | When it last fired |
last_errorrequired | string | null | Why the last firing produced no run, if it produced none |
created_atrequired | string (date-time) | When it was created |
updated_atrequired | string (date-time) | When it was last edited |
Endpoints
8 endpoints, each on its own page with its parameters, responses, error codes and samples in curl, Node and Python.