Docs/API reference

Webhooks

Register, update and delete webhook endpoints that receive Emailchaser events as they happen.

get /webhooks List webhookspost /webhooks Register a webhookput /webhooks/{id} Update a webhookdelete /webhooks/{id} Delete a webhook

List webhooks

get https://api.emailchaser.com/r/webhooks
Works with a read-only key

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

Responses

Fields in the 200 response
  • total integer
    Example: 2
  • webhooks array of WebhookResponse
    7 fields inside webhooks
    • createdAt string
      Example: 2024-01-15T10:30:00Z
    • id integer
      Example: 123
    • isEnabled boolean
      Example: true
    • name string
      Example: LeadCreated webhook
    • status string
      Example: active
    • type string
      Example: LeadCreated
    • url string
      Example: https://hook.make.com/abc123

Request

curl -X GET "https://api.emailchaser.com/r/webhooks" \
  -H "Authorization: Bearer $EMAILCHASER_API_KEY"

Response

{
  "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 https://api.emailchaser.com/r/webhooks
Needs a read and write key

Registers a webhook endpoint that will be called when the given event type occurs (e.g. LeadCreated, CampaignStatusChanged, EmailReply). The URL must use HTTPS. A signing secret is created for the webhook, but the API does not return it. Copy it in the app under Settings, Integrations & API, on the Webhooks tab, where you can also rotate it.

Request bodyJSON · RegisterWebhookRequest

  • name string
  • type string required
  • url string required

Responses

Fields in the 201 response
  • message string
    Example: webhook registered successfully
  • webhook WebhookResponse
    7 fields inside webhook
    • createdAt string
      Example: 2024-01-15T10:30:00Z
    • id integer
      Example: 123
    • isEnabled boolean
      Example: true
    • name string
      Example: LeadCreated webhook
    • status string
      Example: active
    • type string
      Example: LeadCreated
    • url string
      Example: https://hook.make.com/abc123

Request

curl -X POST "https://api.emailchaser.com/r/webhooks" \
  -H "Authorization: Bearer $EMAILCHASER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Jane Doe",
  "type": "string",
  "url": "https://example.com/webhooks/emailchaser"
}'

Response

{
  "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 https://api.emailchaser.com/r/webhooks/{id}
Needs a read and write key

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.

Parameters

  • id integer required in path

    Webhook ID

Request bodyJSON · UpdateWebhookRequest

  • isEnabled boolean
  • name string
    At least 1 characters. At most 255 characters
  • type string
  • url string

Responses

Fields in the 200 response
  • message string
    Example: webhook updated successfully
  • webhook WebhookResponse
    7 fields inside webhook
    • createdAt string
      Example: 2024-01-15T10:30:00Z
    • id integer
      Example: 123
    • isEnabled boolean
      Example: true
    • name string
      Example: LeadCreated webhook
    • status string
      Example: active
    • type string
      Example: LeadCreated
    • url string
      Example: https://hook.make.com/abc123

Request

curl -X PUT "https://api.emailchaser.com/r/webhooks/123" \
  -H "Authorization: Bearer $EMAILCHASER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "isEnabled": true,
  "name": "Jane Doe",
  "type": "string",
  "url": "https://example.com/webhooks/emailchaser"
}'

Response

{
  "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 https://api.emailchaser.com/r/webhooks/{id}
Needs a read and write key

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

Parameters

  • id integer required in path

    Webhook ID

Responses

Fields in the 200 response
  • id integer
    Example: 123
  • message string
    Example: webhook deleted successfully

Request

curl -X DELETE "https://api.emailchaser.com/r/webhooks/123" \
  -H "Authorization: Bearer $EMAILCHASER_API_KEY"

Response

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

Generated from the Emailchaser API's own OpenAPI definition, so it always matches the running API.