Webhooks

Webhooks let you to receive real-time notifications when specific events occur. You can subscribe, retrieve, update, and delete webhooks using the API. An account can have up to 5 webhooks; the serverUrl must be HTTPS. Payload formats are described in Webhooks.

Values for events: incoming_whatsapp_message, outgoing_whatsapp_message, incoming_instagram_message, outgoing_instagram_message, incoming_telegram_message, outgoing_telegram_message, incoming_messenger_message, outgoing_messenger_message, incoming_website_message, outgoing_website_message, incoming_tiktok_message, outgoing_tiktok_message, client_created, client_tag_added, client_tag_removed, contact_created, contact_tag_added, contact_tag_removed, appointment_scheduled, appointment_rescheduled, appointment_cancelled, appointment_visited, appointment_no_show, appointment_double_confirmed, class_participant_scheduled, class_participant_rescheduled, class_participant_cancelled, class_participant_visited, class_participant_no_show, class_participant_waitlisted, invoice_draft, invoice_sent, invoice_pending, invoice_paid.

Client events need the CRM Suite add-on, appointment and class events need Bookings, and invoice events need Sales.

API regionapi.whautomate.com

Get All Webhooks

Retrieve a list of all registered webhooks.

GET /v1/webhooks

Headers

x-api-keystringrequired

Your Whautomate API key.

Query parameters

limitstring

pagestring

Response 200

idstring

Unique identifier for the endpoint

namestringrequired

Human-readable name for the endpoint

activebooleanrequired

Indicates whether the endpoint is active or not

serverUrlstringrequired

URL of the server where webhooks are sent

webhookHeadersobject[]

Array of HTTP headers to be included in webhook requests

eventsstring (enum)[]required

Array of events that trigger webhooks for this endpoint

createdAtstring

Timestamp of endpoint creation

updatedAtstring

Timestamp of endpoint update

Request

curl -X GET "https://api.whautomate.com/v1/webhooks" \
  -H "x-api-key: YOUR_API_KEY"

Response 200

[
  {
    "id": "string",
    "name": "string",
    "active": true,
    "serverUrl": "string",
    "webhookHeaders": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "events": [
      "incoming_whatsapp_message"
    ],
    "createdAt": "2025-01-01T10:00:00.000Z",
    "updatedAt": "2025-01-01T10:00:00.000Z"
  }
]

Create Webhook

Register a new webhook subscription.

POST /v1/webhooks

Headers

x-api-keystringrequired

Your Whautomate API key.

Body

idstring

Unique identifier for the endpoint

namestringrequired

Human-readable name for the endpoint

activebooleanrequired

Indicates whether the endpoint is active or not

serverUrlstringrequired

URL of the server where webhooks are sent

webhookHeadersobject[]

Array of HTTP headers to be included in webhook requests

eventsstring (enum)[]required

Array of events that trigger webhooks for this endpoint

createdAtstring

Timestamp of endpoint creation

updatedAtstring

Timestamp of endpoint update

Response 200

idstring

Unique identifier for the endpoint

namestringrequired

Human-readable name for the endpoint

activebooleanrequired

Indicates whether the endpoint is active or not

serverUrlstringrequired

URL of the server where webhooks are sent

webhookHeadersobject[]

Array of HTTP headers to be included in webhook requests

eventsstring (enum)[]required

Array of events that trigger webhooks for this endpoint

createdAtstring

Timestamp of endpoint creation

updatedAtstring

Timestamp of endpoint update

Request

curl -X POST "https://api.whautomate.com/v1/webhooks" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "name": "string",
    "active": true,
    "serverUrl": "string",
    "webhookHeaders": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "events": [
      "incoming_whatsapp_message"
    ],
    "createdAt": "2025-01-01T10:00:00.000Z",
    "updatedAt": "2025-01-01T10:00:00.000Z"
  }'

Response 200

{
  "id": "string",
  "name": "string",
  "active": true,
  "serverUrl": "string",
  "webhookHeaders": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "events": [
    "incoming_whatsapp_message"
  ],
  "createdAt": "2025-01-01T10:00:00.000Z",
  "updatedAt": "2025-01-01T10:00:00.000Z"
}

Get Webhook By Id

Retrieve details of a specific webhook subscription.

GET /v1/webhooks/{webhookId}

Headers

x-api-keystringrequired

Your Whautomate API key.

Path parameters

webhookIdstringrequired

Response 200

idstring

Unique identifier for the endpoint

namestringrequired

Human-readable name for the endpoint

activebooleanrequired

Indicates whether the endpoint is active or not

serverUrlstringrequired

URL of the server where webhooks are sent

webhookHeadersobject[]

Array of HTTP headers to be included in webhook requests

eventsstring (enum)[]required

Array of events that trigger webhooks for this endpoint

createdAtstring

Timestamp of endpoint creation

updatedAtstring

Timestamp of endpoint update

Request

curl -X GET "https://api.whautomate.com/v1/webhooks/{webhookId}" \
  -H "x-api-key: YOUR_API_KEY"

Response 200

{
  "id": "string",
  "name": "string",
  "active": true,
  "serverUrl": "string",
  "webhookHeaders": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "events": [
    "incoming_whatsapp_message"
  ],
  "createdAt": "2025-01-01T10:00:00.000Z",
  "updatedAt": "2025-01-01T10:00:00.000Z"
}

Update Webhook

Update an existing webhook subscription.

PUT /v1/webhooks/{webhookId}

Headers

x-api-keystringrequired

Your Whautomate API key.

Path parameters

webhookIdstringrequired

Body

idstring

Unique identifier for the endpoint

namestringrequired

Human-readable name for the endpoint

activebooleanrequired

Indicates whether the endpoint is active or not

serverUrlstringrequired

URL of the server where webhooks are sent

webhookHeadersobject[]

Array of HTTP headers to be included in webhook requests

eventsstring (enum)[]required

Array of events that trigger webhooks for this endpoint

createdAtstring

Timestamp of endpoint creation

updatedAtstring

Timestamp of endpoint update

Response 200

idstring

Unique identifier for the endpoint

namestringrequired

Human-readable name for the endpoint

activebooleanrequired

Indicates whether the endpoint is active or not

serverUrlstringrequired

URL of the server where webhooks are sent

webhookHeadersobject[]

Array of HTTP headers to be included in webhook requests

eventsstring (enum)[]required

Array of events that trigger webhooks for this endpoint

createdAtstring

Timestamp of endpoint creation

updatedAtstring

Timestamp of endpoint update

Request

curl -X PUT "https://api.whautomate.com/v1/webhooks/{webhookId}" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "name": "string",
    "active": true,
    "serverUrl": "string",
    "webhookHeaders": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "events": [
      "incoming_whatsapp_message"
    ],
    "createdAt": "2025-01-01T10:00:00.000Z",
    "updatedAt": "2025-01-01T10:00:00.000Z"
  }'

Response 200

{
  "id": "string",
  "name": "string",
  "active": true,
  "serverUrl": "string",
  "webhookHeaders": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "events": [
    "incoming_whatsapp_message"
  ],
  "createdAt": "2025-01-01T10:00:00.000Z",
  "updatedAt": "2025-01-01T10:00:00.000Z"
}

Delete Webhook

Remove a webhook subscription.

DEL /v1/webhooks/{webhookId}

Headers

x-api-keystringrequired

Your Whautomate API key.

Path parameters

webhookIdstringrequired

Response 200

successboolean

Request

curl -X DELETE "https://api.whautomate.com/v1/webhooks/{webhookId}" \
  -H "x-api-key: YOUR_API_KEY"

Response 200

{
  "success": true
}

Related

• Whautomate Rest API
• REST API error messages