The “Schedule Triggered” webhook can be activated by schedules when their trigger conditions are met. For example:
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.
The following data will be included as a JSON payload in the POST
request when the webhook is triggered.
Identifies the event type. In this case, ScheduleTriggered
.
The project identifier.
Internal participant ID.
Project-specific participant identifier.
Identifier for the schedule the event is associated with.
Name for the schedule the event is associated with.
{
"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"
}