Reference of the Hapti webhooks endpoints: parameters, fields and real responses.
Every endpoint takes a key in the Authorization header: Authorization: Bearer hp_test_.... Base address: https://api.hapti.dev. The full specification is in openapi.json .
# Create an endpoint
HTTP Copy POST /v1/webhooks/endpoints
An https address that receives the events you choose, signed with its own secret. The secret is returned once here.
Parameter In Description Idempotency-Keyheader Any unique string of 1 to 255 visible characters. The same key with the same request within 24 hours returns the first answer again instead of acting twice.
Field Type Description urlstring eventsarray Event types, a family like user., or [" "] for every event, including future ones. descriptionstring headersobject Up to 10 headers sent with each delivery. enabledboolean
Response 201 Copy {
"id": "we_0e47caf33717b1a8",
"object": "webhook_endpoint",
"url": "https://api.example.com/hooks/hapti",
"events": [
"task.succeeded",
"task.failed",
"task.waiting"
],
"description": "Production",
"enabled": true,
"disabled_reason": null,
"disabled_at": null,
"failing_since": null,
"last_success_at": null,
"headers": {},
"mode": "test",
"secret": "whsec_0f9c3a…",
"previous_secret_expires_at": null,
"created_at": "2026-11-22T18:40:56.225Z"
}
# List endpoints
HTTP Copy GET /v1/webhooks/endpoints
With their deliveries and failures of the last 7 days.
# Get an endpoint
HTTP Copy GET /v1/webhooks/endpoints/{id}
Parameter In Description idpath Webhook endpoint id
# Update an endpoint
HTTP Copy PATCH /v1/webhooks/endpoints/{id}
Address, events, description, headers, or enabled to pause and resume.
Parameter In Description idpath Webhook endpoint id
Field Type Description urlstring eventsarray Event types, a family like user., or [" "] for every event, including future ones. descriptionstring headersobject Up to 10 headers sent with each delivery. enabledboolean
# Delete an endpoint
HTTP Copy DELETE /v1/webhooks/endpoints/{id}
Parameter In Description idpath Webhook endpoint id
# Reveal the secret
HTTP Copy GET /v1/webhooks/endpoints/{id}/secret
Parameter In Description idpath Webhook endpoint id
# Roll the secret
HTTP Copy POST /v1/webhooks/endpoints/{id}/roll-secret
A new secret; the previous one stays valid for expires_in_hours (24 by default, 0 to 168) and each delivery carries both signatures meanwhile.
Parameter In Description idpath Webhook endpoint id
Field Type Description expires_in_hoursinteger
# Send a test event
HTTP Copy POST /v1/webhooks/endpoints/{id}/test
Sends a signed ping event now and returns the delivery with the answer of your server.
Parameter In Description idpath Webhook endpoint id
# Send missed events again
HTTP Copy POST /v1/webhooks/endpoints/{id}/recover
Sends once every event of the period that never reached this endpoint.
Parameter In Description idpath Webhook endpoint id
Field Type Description sincestring 3 days ago by default, at most 30
# Reveal the organisation secret
HTTP Copy GET /v1/webhook/secret
The secret that signs the deliveries of webhooks given on a task or a batch with the webhook field.
# List event types
HTTP Copy GET /v1/webhooks/events
# List deliveries
HTTP Copy GET /v1/webhooks/deliveries
Parameter In Description endpointquery Endpoint id eventquery Event type statequery pending, delivered or failed limitquery Up to 100 cursorquery next_cursor of the previous page
# Get a delivery
HTTP Copy GET /v1/webhooks/deliveries/{id}
With every attempt, the answer of your server and the body sent.
Parameter In Description idpath Delivery id
# Send a delivery again
HTTP Copy POST /v1/webhooks/deliveries/{id}/resend
Parameter In Description idpath Delivery id