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

Add a new webhook for lead.created event

POSThttps://api2.engineroom.com.au/public/webhooks

Authorization

bearerAuth

Query parameters

Header parameters

Response

201400

Webhook created successfully

Request

JavaScriptCurlPython

const response = await fetch('https://api2.engineroom.com.au/public/webhooks?event=lead.created&url=https%3A%2F%2Fexample.com%2Fwebhook-receiver&http_verb=POST', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Accept": "application/json"
    },
});
const data = await response.json();

Deleting a webhook

Delete a webhook

Delete an existing webhook by ID

DELETEhttps://api2.engineroom.com.au/public/webhooks/{id}

Authorization

bearerAuth

Path parameters

id*string

The ID of the webhook to be deleted

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

Header parameters

Response

200400

Webhook deleted successfully

Request

JavaScriptCurlPython

const response = await fetch('https://api2.engineroom.com.au/public/webhooks/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>",
      "Accept": "application/json"
    },
});
const data = await response.json();