Skip to main content
GET
/
api
/
programs
/
{id}
/
triggers
List contact triggers for a live program
curl --request GET \
  --url http://localhost:3000/api/programs/{id}/triggers \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "contactId": "<string>",
    "contactPhone": "<string>",
    "triggerAt": "<string>",
    "attributeValue": "<string>",
    "status": "pending",
    "createdAt": "<string>",
    "contactName": "<string>",
    "triggeredAt": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Program ID

Query Parameters

​
status
enum<string>

Filter by trigger status

Available options:
pending,
triggered,
cancelled

Response

List of contact triggers

​
id
string
required

Trigger ID

​
contactId
string
required

Contact ID

​
contactPhone
string
required

Contact primary phone

​
triggerAt
string
required

When the trigger fires

​
attributeValue
string
required

The raw date attribute value

​
status
enum<string>
required

Trigger status

Available options:
pending,
triggered,
cancelled
​
createdAt
string
required

When the trigger was created

​
contactName
string | null

Contact full name

​
triggeredAt
string | null

When the trigger was processed