Schedule Triggered Webhook
The “Schedule Triggered” webhook can be activated by schedules when their trigger conditions are met. For example:
- When a participant enrolls, enters a segment, or meets certain criteria.
- Based on participant events, such as two weeks after a surgery date.
- On a specific calendar day or cadence, such as every week.
Note
The webhook will be triggered once for each affected participant in the schedule. Some schedules are for a single participant (e.g., “on enrollment”), but others may be for a segment or even all participants.
The webhook will be triggered once for each affected participant in the schedule. Some schedules are for a single participant (e.g., “on enrollment”), but others may be for a segment or even all participants.
You may create multiple “Schedule Triggered” webhooks and trigger them from different schedules.
See the user guide article on Schedules for more information about setting up a schedule.
Event Data
The following data will be included as a JSON payload in the POST request when the webhook is triggered.
eventType
string
Identifies the event type. In this case, ScheduleTriggered.
projectID
The project identifier.
participantID
guid
Internal participant ID.
participantIdentifier
string
Project-specific participant identifier.
scheduleID
guid
Identifier for the schedule the event is associated with.
scheduleName
guid
Name for the schedule the event is associated with.
Sample Webhook Data
{
"eventType": "ScheduleTriggered",
"projectID": "3a713a06-295d-4803-9602-776f09a1483b",
"participantID": "419d567e-76e6-4b53-8b3c-567d7260a85d",
"participantIdentifier": "PT-123",
"scheduleID": "083b44c8-4273-4ad5-9132-3dce126d5e62",
"scheduleName": "Welcome Message"
}{
"eventType": "ScheduleTriggered",
"projectID": "3a713a06-295d-4803-9602-776f09a1483b",
"participantID": "419d567e-76e6-4b53-8b3c-567d7260a85d",
"participantIdentifier": "PT-123",
"scheduleID": "083b44c8-4273-4ad5-9132-3dce126d5e62",
"scheduleName": "Welcome Message"
}
