Webhooks
Use the REST API to interact with Webhooks
Webhooks will be triggered when specific events occur. At present we only support lead.created
via the Public API
Creating a new webhook
Add a new webhook for lead.created event
Authorizations
Query parameters
eventstring · enumRequiredPossible values:
The event for which the webhook will be triggered
urlstring · uriRequiredExample:
The URL to which the webhook will send the payload
https://example.com/webhook-receiver
http_verbstring · enumRequiredPossible values:
The HTTP verb to be used when sending the payload (e.g., POST, GET, PUT, DELETE)
Header parameters
AcceptstringRequiredExample:
Request content type
application/json
Responses
201
Webhook created successfully
400
Invalid input
post
POST /public/webhooks HTTP/1.1
Host: api2.engineroom.com.au
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json
No content
Deleting a webhook
Delete an existing webhook by ID
Authorizations
Path parameters
idstringRequiredExample:
The ID of the webhook to be deleted
296130fc-6fa5-48db-a571-925d60309ed1
Header parameters
AcceptstringRequiredExample:
Request content type
application/json
Responses
200
Webhook deleted successfully
400
Invalid input
delete
DELETE /public/webhooks/{id} HTTP/1.1
Host: api2.engineroom.com.au
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json
No content
Last updated