Webhooks
Webhooks allow Scrollengine to notify your external systems in real-time when events occur. Use webhooks to build custom integrations, automate workflows, or sync data with other tools.
What are webhooksโ
A webhook is an HTTP POST request sent to a URL you specify whenever a specific event happens in Scrollengine. Your server receives the event data and can act on it.
Available webhook eventsโ
| Event | Trigger |
|---|---|
order.created | New delivery order is placed |
order.updated | Order details or status change |
order.delivered | Order is marked as delivered |
order.cancelled | Order is cancelled |
route.created | New route is created |
route.started | Driver starts a route |
route.completed | All stops on a route are done |
driver.assigned | Driver is assigned to an order or route |
Setting up a webhookโ
- Go to Settings > Integrations > Webhooks
- Click Add Webhook
- Enter:
- URL โ The endpoint on your server that will receive the webhook
- Events โ Select which events to subscribe to
- Secret โ A shared secret for verifying webhook authenticity
- Click Save
Webhook payloadโ
Webhooks are sent as HTTP POST requests with a JSON body:
{
"event": "order.delivered",
"timestamp": "2026-03-13T14:30:00Z",
"data": {
"order_id": "12345",
"shopify_order_id": "98765",
"delivery_method": "local_delivery",
"status": "delivered",
"driver": {
"id": "d-001",
"name": "John Driver"
}
}
}
Verifying webhooksโ
Each webhook includes a signature header for verification:
- Scrollengine signs the payload using your shared secret
- The signature is included in the
X-Scrollengine-Signatureheader - Your server should verify the signature before processing
Retry policyโ
If your endpoint returns a non-2xx status code:
- Scrollengine retries up to 3 times
- Retries use exponential backoff (1 min, 5 min, 30 min)
- After 3 failures, the webhook is marked as failing
- You'll receive a notification to fix your endpoint
Use casesโ
- Sync to an ERP โ Push delivery data to your inventory or accounting system
- Custom notifications โ Trigger SMS, Slack, or other alerts
- Analytics โ Feed delivery events into your analytics platform
- Third-party logistics โ Notify external carriers or partners