Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Scopes

whatsapp:write

Path Parameters

uuid
string<uuid>
required

ID of the webhook, as returned in uuid when you create the webhook or list your webhooks.

Body

application/json

Attributes of the webhook to change.

Fields to update on a WhatsApp webhook. Consumed by Update a WhatsApp webhook. Specify at least one field; fields you omit keep their values.

url
string<uri>

New https URL that Wavix sends events to. Wavix checks it the same way as when you create a webhook.

Maximum string length: 2048
Example:

"https://example.com/wavix/v2"

enabled
boolean

Whether Wavix sends events to the webhook. When false, Wavix sends only test events. Read the others with List WhatsApp events.

Example:

false

Response

The updated WhatsApp webhook. It never includes the signing secret.

A single WhatsApp webhook, returned when you create or retrieve a webhook.

webhook
WhatsAppWebhook · object
required

A WhatsApp webhook of your account, returned when you create, list, or retrieve a webhook.