[BETA] Register a webhook

Register a webhook for your school: an event type and the https URL it is delivered to. The same event type can target several URLs; registering the same event type and URL twice returns 409 WEBHOOK_ALREADY_EXISTS.

Learner added to a training

Subscribe to on_training_student_added to receive one POST per learner newly associated with a training. Covers enrollment through the School platform, public registration and enrollment API writes. Re-submitting an unchanged membership emits nothing; removing and adding the learner again is a new enrollment. Bulk enrollment emits one event per new learner/training pair.

Registering through API v3 does not change the delivery format: standard webhooks retain the existing v1 entity field names. The standard webhook body contains type, appId (present only for marketplace subscriptions), studentId, trainingId, addedAt, student and training:

{
  "type": "on_training_student_added",
  "studentId": "student-123",
  "trainingId": "training-456",
  "addedAt": "2026-11-07T10:00:00.000Z",
  "student": { "ID": "student-123", "FIRSTNAME": "Alex", "LASTNAME": "Martin", "EMAIL": "[email protected]", "API_ID": "SC-123", "DATE_CREATED": "2026-11-07T09:00:00.000Z" },
  "training": { "ID": "training-456", "NAME": "Safety training", "API_ID": "SC-456", "START": "2026-12-01 09:00:00", "END": "2026-12-02 17:00:00" }
}

addedAt and student.DATE_CREATED are UTC ISO 8601 timestamps. training.START and training.END use the school's local timezone (YYYY-MM-DD HH:mm:ss), like existing v1 course webhooks. EMAIL is omitted for a learner without email. Learner and training details are resolved at delivery processing time. Existing webhook headers, signatures and retry behavior apply; receivers should tolerate duplicate delivery.

The equivalent automation trigger is training_student_added. It exposes student.email, student.createdAt, training.name, training.start, training.end and enrollment.addedAt. To welcome only recently created learners, use the existing date condition: student.createdAt less than 1440 minutes before enrollment.addedAt, then send email to {{student.email}} with {{training.start | school_date(school.timezone, school.language)}} for a date formatted in the school timezone and language. This checks a rolling 24-hour window; it does not wait for another event or enforce one welcome email over the learner's lifetime.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Event type to subscribe to: a WebhookType or ScheduledWebhookType value.

string
required
length ≤ 2048

Delivery target: an absolute https URL, 2048 characters maximum, surrounding whitespace trimmed. Local and private network addresses are rejected.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json