Webhooks

List webhooks

get

Lists all registered webhook endpoints for the authenticated user's space.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Responses

200

List of webhooks

application/json

totalintegerOptionalExample: 2

401

Unauthorized - invalid or missing API key

application/json

500

Failed to retrieve webhooks

application/json

get/webhooks

HTTPcURLJavaScriptPython

GET /r/webhooks HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Accept: */*

{
  "total": 2,
  "webhooks": [
    {
      "createdAt": "2024-01-15T10:30:00Z",
      "id": 123,
      "isEnabled": true,
      "name": "LeadCreated webhook",
      "status": "active",
      "type": "LeadCreated",
      "url": "https://hook.make.com/abc123"
    }
  ]
}

Register a webhook

post

Registers a webhook endpoint that will be called when the given event type occurs (e.g. LeadCreated, CampaignStatusChanged, EmailReply). The URL must use HTTPS.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Body

application/json

namestringOptional

typestringRequired

urlstringRequired

Responses

201

Webhook registered successfully

application/json

messagestringOptionalExample: webhook registered successfully

400

Invalid request body, webhook type or URL

application/json

401

Unauthorized - invalid or missing API key

application/json

500

Failed to register webhook

application/json

post/webhooks

HTTPcURLJavaScriptPython

POST /r/webhooks HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "name": "text",
  "type": "text",
  "url": "text"
}

{
  "message": "webhook registered successfully",
  "webhook": {
    "createdAt": "2024-01-15T10:30:00Z",
    "id": 123,
    "isEnabled": true,
    "name": "LeadCreated webhook",
    "status": "active",
    "type": "LeadCreated",
    "url": "https://hook.make.com/abc123"
  }
}

Update a webhook

put

Updates a registered webhook's name, URL, event type or enabled state. Only provided fields are changed. Disabling a webhook stops deliveries without deleting it.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idintegerRequired

Webhook ID

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Body

application/json

isEnabledbooleanOptional

namestring · min: 1 · max: 255Optional

typestringOptional

urlstringOptional

Responses

200

Webhook updated successfully

application/json

messagestringOptionalExample: webhook updated successfully

400

Invalid webhook ID, request body, type or URL

application/json

401

Unauthorized - invalid or missing API key

application/json

404

Webhook not found

application/json

500

Failed to update webhook

application/json

put/webhooks/{id}

HTTPcURLJavaScriptPython

PUT /r/webhooks/{id} HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "isEnabled": true,
  "name": "text",
  "type": "text",
  "url": "text"
}

{
  "message": "webhook updated successfully",
  "webhook": {
    "createdAt": "2024-01-15T10:30:00Z",
    "id": 123,
    "isEnabled": true,
    "name": "LeadCreated webhook",
    "status": "active",
    "type": "LeadCreated",
    "url": "https://hook.make.com/abc123"
  }
}

Delete a webhook

delete

Deletes a registered webhook endpoint. Events of its type will no longer be delivered to its URL.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idintegerRequired

Webhook ID

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Responses

200

Webhook deleted successfully

application/json

idintegerOptionalExample: 123

messagestringOptionalExample: webhook deleted successfully

400

Invalid webhook ID

application/json

401

Unauthorized - invalid or missing API key

application/json

404

Webhook not found

application/json

500

Failed to delete webhook

application/json

delete/webhooks/{id}

HTTPcURLJavaScriptPython

DELETE /r/webhooks/{id} HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Accept: */*

{
  "id": 123,
  "message": "webhook deleted successfully"
}