> For the complete documentation index, see [llms.txt](https://docs.sparkloop.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sparkloop.app/api-v3/objects-schema/webhook-object.md).

# Webhook Object

## Webhook Object

| Field        | Type   | Description                                   |
| ------------ | ------ | --------------------------------------------- |
| `uuid`       | String | Webhook UUID.                                 |
| `url`        | String | The destination URL (`https`).                |
| `status`     | String | `active` or `inactive`.                       |
| `created_at` | String | When the webhook was created (ISO 8601).      |
| `updated_at` | String | When the webhook was last updated (ISO 8601). |
| `events`     | Array  | The enabled event names.                      |

Available events: `new_referral`, `reward_unlocked`, `reward_redeemed`, `sync_subscriber`, `new_partner_referral`, `new_partner_pending_referral`, `new_opportunity`, and the read-only `new_offer_lead`.

**Example**

```json
{
  "uuid": "wh_5c6d7e8f",
  "url": "https://example.com/hooks/sparkloop",
  "status": "active",
  "created_at": "2025-07-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "events": ["new_referral", "reward_unlocked"]
}
```