---
title: "Subscribe to webhook events"
method: POST
path: "/webhooks"
tags: ["Webhooks"]
---

# Subscribe to webhook events

`POST /webhooks`

## Request

- Base URL: `https://api.heffl.com/api/v1`
- URL: `https://api.heffl.com/api/v1/webhooks`
- Auth: API key in header `x-api-key`

Creates a webhook endpoint that receives HTTP POST notifications when specified events occur.

## Request body

- object
  - `name` string, required: Webhook name (e.g. 'Zapier: New Lead')
  - `url` string, uri, required: URL to receive webhook POST requests
  - `events` string[], required: Events to subscribe to

## Response `200`

OK

- object
  - `id` string, required: Webhook endpoint public ID
  - `name` string, required
  - `url` string, required
  - `events` string[], required
  - `status` string, required
  - `secret` string, required: Signing secret (one-time reveal)
  - `createdAt` string, date-time, required

---

[API](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1.md) · [All operations](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1/revisions/9bdb229223a2?raw)