List campaigns for the widget
Ongoing campaigns this inbox may trigger, with their rules. The widget evaluates them against the page the visitor is on and the time they have spent there, then triggers one by sending an event. Empty when the inbox has no enabled ongoing campaign.
Authorizations
The signed session token from POST /api/v1/widget/config. Sent alongside website_token in the query string on every widget request. See /api-reference/widget-api-authentication.
Query Parameters
The web-widget inbox's public token, as it appears in your widget snippet. Required on every widget request.
"EXAMPLE_WEBSITE_TOKEN"
Response
Success
The campaign's display_id. This is the value the campaign endpoints take in the path.
Internal name for the campaign.
Internal description. Not shown to contacts.
The account the campaign belongs to.
The message body sent to the contact.
WhatsApp template parameters, for campaigns on a WhatsApp inbox that send an approved template.
A one-off campaign becomes completed once it has been sent. A completed campaign cannot be updated.
active, completed Whether the campaign is live. An ongoing campaign with enabled: false stops triggering.
Derived from the inbox, never from the request. A website inbox always produces ongoing; an SMS, Twilio SMS or WhatsApp inbox always produces one_off.
ongoing, one_off Conditions for an ongoing campaign. url is the page the visitor must be on, and time_on_page the seconds to wait before sending.
Whether to suppress the campaign outside the inbox's configured business hours.
When a one-off campaign is due to send. Always null on an ongoing campaign — it is cleared on save.
ISO-8601 timestamp of creation.
ISO-8601 timestamp of the last update.