# Webhook

The Webhook object of the Kaabist API.

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string | yes | pattern `^whk_[0-9a-hjkmnp-tv-z]{26}$` |
| `object` | `"webhook"` | yes |  |
| `url` | string (uri) | yes |  |
| `events` | string[] | yes | min items 1 |
| `mode` | `"live"`, `"test"`, `"both"` | yes |  |
| `format` | `"standard"`, `"discord"`, `"slack"` | yes |  |
| `status` | `"active"`, `"disabled"` | yes |  |
| `description` | string or null | yes |  |
| `disabled_reason` | string or null | yes |  |
| `previous_secret_expires_at` | string or null (date-time) | yes |  |
| `created_at` | string (date-time) | yes |  |

## Example

```json
{
  "id": "whk_01j9zqk3q7m4n5p6r7s8t9v0wx",
  "object": "webhook",
  "url": "https://hooks.acme.test/kaab",
  "events": [
    "job.*",
    "credits.low"
  ],
  "mode": "both",
  "format": "standard",
  "status": "active",
  "description": null,
  "disabled_reason": null,
  "previous_secret_expires_at": null,
  "created_at": "2026-09-18T10:00:00Z"
}
```