Create webhooks

Retained legacy exception: Create a subscription; V3 manages the resulting subscription.

Legacy exception: webhook creation currently uses this V2 route; manage the returned subscription with the V3 webhook APIs. phoneNumber is the sending WhatsApp channel number, not a customer phone or channel ID. Set numeric status=1 to enable; status=0 creates a disabled subscription. Select eventTypes from the V3 event-types endpoint for this workspace. Check ok and retain the returned subscription ID. Supported event availability does not imply all channels can use this creation route.

Create webhooks. POST /{tenantId}/api/v2/webhookEndpoints.

Permissions

For API access tokens and OIDC tokens, satisfy at least one of: api, webhooks:create. API access tokens may satisfy a listed scope through the configured scope hierarchy; OIDC tokens are checked against their scope claims. Legacy JWT authentication does not use this scope check. Authentication, role, tenant, and applicable feature or plan checks still apply. For HTTP 403, check the credential type, applicable scopes, roles, and workspace access; 403 does not always mean a missing scope. Authentication/authorization failures do not guarantee a JSON response body.

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

Your WATI workspace (tenant) ID. This required path segment identifies the WATI account for legacy v1 and v2 API requests.

Body Params
Responses

403

Authorization failed. Check the Permissions section for the credential-specific scope rules, and check roles and workspace access. The response may have no body; do not require a JSON error envelope.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json