Webhooks

Subscribe to webhook events

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

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

Request body

namestring required

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

urlstring uri required

URL to receive webhook POST requests

eventsstring[] required

Events to subscribe to

Response

OK

idstring required

Webhook endpoint public ID

namestring required
urlstring required
eventsstring[] required
statusstring required
secretstring required

Signing secret (one-time reveal)

createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.