Skip to main content

Add a webhook

On the API’s page, choose Add Webhook, enter your address and choose the resources it hears about. A school can have up to 10 webhooks.
  • The address must be https on the standard port, with a domain name. IP addresses and local names aren’t accepted.
  • The signing secret is shown once. Store it to verify signatures.

Events

Events are thin. They say what changed, and your system reads the record through the API with its own key, so a webhook never sends anything the key couldn’t read.
Changes from before the webhook was added, or more than a day old, aren’t sent.

Delivery and retries

  • SchoolCues posts each event as JSON with the user agent SchoolCues-Webhooks/1.0. Any 2xx response accepts it.
  • It waits 10 seconds for a response and never follows redirects. Enter the final address.
  • An event your address refuses is retried after 2, 4, 8 and 16 minutes. After that it stays failed until someone retries it from the API’s page.
  • Each event keeps its id on every retry, so use it to ignore repeats.

Switched off after 3 days

If an address refuses every event for 3 days, its webhook is switched off and the school’s integration administrators are emailed. Turn On in the webhook’s row menu starts sending again, including the last day’s changes that weren’t sent.