Create a Webhook
POST /v1/webhooks
Request Body
["*"] in events to subscribe to all platform events.
Response — 201 Created
Webhooks
Create a Webhook
Register a new webhook subscription to receive Essal platform events at your endpoint.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Register a new webhook subscription to receive Essal platform events at your endpoint.
POST /v1/webhooks
Request Body
{
"url": "https://hooks.example.com/essal",
"events": [
"office.document.created",
"sales.deal.won",
"careers.application.submitted",
"guard.alert.triggered"
],
"description": "Main integration endpoint"
}
["*"] in events to subscribe to all platform events.
Response — 201 Created
{
"id": "wh_01HXYZWH1",
"url": "https://hooks.example.com/essal",
"secret": "whs_live_xxxxxxxxxxxxxx",
"status": "active",
"created_at": "2026-07-10T09:00:00Z"
}
secret is only returned at creation time. Store it securely — it is used to verify the X-Essal-Signature on all incoming payloads.| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes | HTTPS endpoint to receive event payloads |
events | array | Yes | List of event type strings or ["*"] for all |
description | string | No | Human-readable label |