webhooks

create webhook subscription

Subscribe a URL to receive instance events. Up to 25 active subscriptions are allowed per instance. Subscribing an already-registered URL again returns the existing subscription with a 200 status instead of creating a duplicate.

post/instances/{id}/webhooks

Request

Base URL: https://waapi.app/api/v1
URL: https://waapi.app/api/v1/instances/{id}/webhooks
Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Headers

X-Hook-Secretstring

Optional secret chosen by the calling platform (used by Zapier's REST Hook handshake). Stored with the subscription and echoed back in the X-Hook-Secret response header. Never returned in the response body.

Request body

urlstring required

The URL that will receive event payloads.

eventsEventType[] required

source'zapier' | 'make' | 'n8n' | 'api'

Who is registering this subscription. Defaults to api.

Example request

{
  "url": "https://hooks.zapier.com/hooks/standard/123456/abc123/",
  "events": [
    "message",
    "qr"
  ],
  "source": "zapier"
}

Response

A subscription already existed for this URL — returns it instead of creating a duplicate.

Example response

{
  "data": {
    "id": 42,
    "url": "https://hooks.zapier.com/hooks/standard/123456/abc123/",
    "events": [
      "message",
      "qr"
    ],
    "source": "zapier",
    "isActive": true,
    "createdAt": "2026-08-10T12:00:00+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.