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

Deleting a webhook

PreviousSales NextUsers

Last updated 1 year ago

Add a new webhook

Add a new webhook for lead.created event

post

/webhooks

Authorizations

Query parameters

eventstring · enumrequired

The event for which the webhook will be triggered

Options: lead.created

urlstring · urirequired

The URL to which the webhook will send the payload

Example: https://example.com/webhook-receiver

http_verbstring · enumrequired

The HTTP verb to be used when sending the payload (e.g., POST, GET, PUT, DELETE)

Options: POST, PUT

Header parameters

Acceptstringrequired

Request content type

Example: application/json

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api2.engineroom.com.au/public/webhooks?event=lead.created&url=https%3A%2F%2Fexample.com%2Fwebhook-receiver&http_verb=POST' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Accept: application/json'

201

400

No body

Webhook created successfully

Delete a webhook

Delete an existing webhook by ID

delete

/webhooks/{id}

Authorizations

Path parameters

idstringrequired

The ID of the webhook to be deleted

Example: 296130fc-6fa5-48db-a571-925d60309ed1