Skip to main content

Overview

Webhooks let you receive HTTP POST notifications when executions change state. Instead of polling the API, register an endpoint and ModelRoute pushes events to you in real time.

Events

ModelRoute sends 4 webhook event types:

Payload format

Every webhook delivery is a JSON POST with this structure:

Delivery headers

Each webhook request includes these headers:

Signature verification

Every webhook is signed with HMAC-SHA256 using your endpoint’s secret. Always verify signatures before processing. See Webhook Verification for implementation details.

Retry policy

If your endpoint returns a non-2xx status code or does not respond, ModelRoute retries with exponential backoff:
  • Maximum 5 retry attempts per delivery
  • Deliveries expire after 24 hours
  • After 10 consecutive failures across all deliveries, the endpoint is automatically deactivated
Your endpoint must respond within 30 seconds with a 2xx status code. Slow responses are treated as failures and trigger retries.

Deduplication

Each webhook event has a unique id field. If you receive the same event ID twice (due to retries), ignore the duplicate. Store processed event IDs and check before handling.

Next steps

Webhook Setup

Register and manage webhook endpoints.

Signature Verification

Verify HMAC-SHA256 signatures in your language.