> ## Documentation Index
> Fetch the complete documentation index at: https://developers.essal.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a Webhook

> Register a new webhook subscription to receive Essal platform events at your endpoint.

## Create a Webhook

`POST /v1/webhooks`

**Request Body**

```json theme={null}
{
  "url": "https://hooks.example.com/essal",
  "events": [
    "office.document.created",
    "sales.deal.won",
    "careers.application.submitted",
    "guard.alert.triggered"
  ],
  "description": "Main integration endpoint"
}
```

Pass `["*"]` in `events` to subscribe to all platform events.

**Response** — `201 Created`

```json theme={null}
{
  "id": "wh_01HXYZWH1",
  "url": "https://hooks.example.com/essal",
  "secret": "whs_live_xxxxxxxxxxxxxx",
  "status": "active",
  "created_at": "2026-07-10T09:00:00Z"
}
```

<Warning>
  The `secret` is only returned at creation time. Store it securely — it is used to verify the `X-Essal-Signature` on all incoming payloads.
</Warning>

**Parameters**

| 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                          |
