Skip to content
novilDevelopersOpen Novil
GuidesWebhooks

Webhooks

Novil will be able to send an HTTP POST to a URL you register when a route changes state. The first events will be:

Event When
Route planned The route’s fuel plan is ready (status became planned).
Route completed The route finished (status became completed).

Each delivery will carry the route in the same shape GET /v1/routes/{id} returns, so a webhook consumer and a polling consumer can share code.

Poll GET /v1/routes/{id} for routes you care about, or list by status with GET /v1/routes?status=planned to pick up every route whose plan is ready in one request. A few polls an hour is enough; plans do not change from minute to minute. See Rate limits for the budget and Pushing routes from a TMS for what each status means.

Webhooks will be announced in the changelog when they ship.