Skip to main content
WEBHOOK

Headers

webhook-id
string
required

The event’s ID, the same on every retry.

webhook-timestamp
string
required

When it was sent, in Unix seconds.

webhook-signature
string
required

v1, then the base64 HMAC-SHA256 of {id}.{timestamp}.{body}.

Body

application/json

What a webhook posts when a record changes. Events are thin: read the record through the API with your own key, so a webhook never sends anything the key couldn't read.

id
string
required

The event's ID, the same on every retry. Use it to ignore repeats.

type
enum<string>
required

What happened.

Available options:
student.created,
student.updated,
contact.created,
contact.updated,
staff.created,
staff.updated,
class.created,
class.updated,
payment.received
occurredAt
string
required

When the record changed, in ISO 8601 (UTC).

school
string
required

The school's ID.

data
object
required

The record that changed.

Response

200

Any 2xx response accepts the event. Anything else, or no answer in 10 seconds, is retried.