# The webhook object

A webhook is an endpoint of yours that Sigil posts events to: its URL, the events it wants, whether it is active, and how its deliveries have been going.

Returned by every call under `/webhooks`. The `secret` appears only when the endpoint is created and when its secret is rolled. See the [webhooks guide](/webhooks) for what is posted and how to verify it.

## Attributes

- `uid` (string): The endpoint's id: 8 letters and digits.
- `url` (string): Where events are posted: a public HTTPS URL.
- `description` (string | null): Your note on what it is for (100 characters at most).
- `events` (array of strings | null): The [event types](/webhooks#events) it receives, or `null` for every pact event. A `ping` is delivered whatever this says.
- `active` (boolean): Whether events are delivered to it. Switched off by you, by a `410 Gone` answer, or after 10 failed deliveries in a row; switch it on again with [Update a webhook](/api-reference/webhooks/update-webhook).
- `consecutive_failures` (integer): Deliveries given up on since the last success. Resets to 0 on the next success.
- `last_status` (integer | null): The HTTP status of the last attempt. `null` before the first attempt, and when the last attempt got no response.
- `date_last_success` (string (date-time) | null): When a delivery last got a `2xx`.
- `date_disabled` (string (date-time) | null): When it was switched off, while it is.
- `date_created` (string (date-time)): When it was added.
- `date_updated` (string (date-time)): When its settings or secret last changed.
- `secret` (string): The signing secret, `sgw_` and 40 letters and digits. Keep it where your receiver can read it. Only in the response to [Create a webhook](/api-reference/webhooks/create-webhook) and [Roll the secret](/api-reference/webhooks/roll-secret). It cannot be read back later.

## Example

```json
{
  "uid": "W8NQ3KTE",
  "url": "https://example.com/sigil/webhook",
  "description": "Production CRM",
  "events": [
    "pact.sealed",
    "pact.declined",
    "pact.voided",
    "pact.lapsed"
  ],
  "active": true,
  "consecutive_failures": 0,
  "last_status": 200,
  "date_last_success": "2026-10-21T09:12:46Z",
  "date_disabled": null,
  "date_created": "2026-10-20T13:58:21Z",
  "date_updated": "2026-10-20T13:58:21Z",
  "secret": "sgw_Qm4Vx7Kp2Lr9TcNb0YhWzS8EaDj3GuPo6RiK1tHfXe"
}
```