Skip to main content
POST
Subscribe to webhook events

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Body

application/json
name
string
required

Webhook name (e.g. 'Zapier: New Lead')

Minimum string length: 1
url
string<uri>
required

URL to receive webhook POST requests

events
string[]
required

Events to subscribe to

Minimum array length: 1
{key}
any

Response

200 - application/json

OK

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