EngineRoom Documentation
  • Documentation
    • EngineRoom Documentation
  • EngineRoom Pixel
    • Setup
      • Webflow
      • WordPress
      • Shopify
      • Google Tag Manager
    • UTM Parameters
  • Conversion AI
    • How we use AI for Conversions
    • Quality scores
    • Session engagement scores
  • WildJar
    • Setup
  • API
    • Overview
    • Quick Start
    • Authentication
    • API Reference
      • Leads
      • Sales
      • Webhooks
      • Users
    • Rate Limits
  • Prompt Engine
    • Overview
  • AI Copilot
    • Overview
Powered by GitBook
On this page
  1. API
  2. API Reference

Webhooks

Use the REST API to interact with Webhooks

PreviousSalesNextUsers

Last updated 1 year ago

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

Add a new webhook

post

Add a new webhook for lead.created event

Authorizations
Query parameters
eventstring · enumRequired

The event for which the webhook will be triggered

Possible values:
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)

Possible values:
Header parameters
AcceptstringRequired

Request content type

Example: 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

Delete a webhook

delete

Delete an existing webhook by ID

Authorizations
Path parameters
idstringRequired

The ID of the webhook to be deleted

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

Request content type

Example: 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

  • Creating a new webhook
  • POSTAdd a new webhook
  • Deleting a webhook
  • DELETEDelete a webhook