Skip to main content
Webhooks tell your systems about job changes, so you do not have to poll the jobs API. Hyperlocalise Platform records each change immediately and sends one signed POST per change to each endpoint you register, usually within a minute. Every change to a job is sent, whoever made it: the Platform UI, the API, the CLI, an automation, or a connected TMS.

Add an endpoint

  1. Open Settings → Webhooks.
  2. Select Add endpoint.
  3. Enter an HTTPS URL on a public host.
  4. Optionally limit the endpoint to one project. Leave All projects selected to receive every project.
  5. Tick the changes to receive. Leave them all unticked to receive every change.
  6. Copy the signing secret. It is shown once. Select Rotate secret to replace it.
Select Send test to send a webhook.test event. Select Recent deliveries to see what was sent, each response status, and the next retry. You need the API keys permission to manage webhooks.

Events

Due date, title, and description changes are sent for jobs created in Hyperlocalise Platform, not for jobs synced from a connected TMS. An endpoint with no changes ticked receives every type, including types added later, so ignore types you do not handle. Statuses are queued, running, succeeded, failed, waiting_for_review, and cancelled.

Payload

For types other than job.status_changed, previousStatus is the same as status. The payload holds IDs and statuses only. Call the jobs API with the job ID for details.

Verify signatures

Signatures follow the Standard Webhooks specification. Each request carries three headers: Any Standard Webhooks library verifies these headers. For example, in Node.js:
Verify the raw body before you parse it. Reject requests whose timestamp is more than five minutes old.

Retries

Return any 2xx status within 10 seconds to accept a delivery. Hyperlocalise Platform does not follow redirects. Failed deliveries are retried after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, 10 hours, and 10 hours, so for about 28 hours in all. Deliveries can arrive out of order; use createdAt to order them. After 40 failed attempts in a row, the endpoint is disabled. A disabled endpoint receives nothing, and deliveries still queued for it are dropped. Fix the receiver, then select Enable in Settings → Webhooks.

Start automations on job changes

To act on job changes inside Hyperlocalise Platform, use the Job changed trigger in a visual automation. It takes the same filters for project, job kind, change type, and new status.