API Reference

create webhook subscription

post
https://waapi.app/api/v1/instances//webhooks

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Instance ID

Body Params
string
required

The URL that will receive event payloads.

events
array of objects
required
events*
string
enum

Who is registering this subscription. Defaults to api.

Allowed:
Headers
string

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.

Responses

401

Unauthorized — invalid or missing bearer token

403

Forbidden — insufficient permissions or account blocked

404

Not found — instance does not exist or does not belong to you

409

Conflict — instance is not ready

429

Too many requests — rate limit exceeded

Updated about 5 hours ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago

Did this page help you?