Skip to main content
PUT
Update a webhook endpoint

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Webhook endpoint UUID

Body

application/json
url
string
required
Example:

"https://example.com/webhook"

events
enum<string>[]
required
Available options:
message.received,
message.sent,
message.delivered,
message.read,
message.failed,
message.reaction,
instance.connected,
instance.disconnected,
instance.qr,
contact.created,
group.joined,
group.left
Example:
secret
string

HMAC secret for verifying webhook signatures

description
string
instance_id
string

Scope to a specific instance. NULL = global (all instances).

headers
object

Custom HTTP headers sent with each delivery

Example:
retry_count
number
default:3
timeout_ms
number
default:5000

Response

Webhook endpoint updated

id
string
required

Webhook endpoint UUID

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

user_id
string
required

Owner user ID

url
string
required

Destination URL

Example:

"https://example.com/webhook"

events
string[]
required

Subscribed event types

Example:
retry_count
number
required

Max retry attempts on failure

Example:

3

timeout_ms
number
required

Request timeout in milliseconds

Example:

5000

is_active
boolean
required

Whether the endpoint is active

Example:

true

created_at
string
required

Creation timestamp

updated_at
string
required

Last update timestamp

secret
string

HMAC secret for signature verification

description
string

Human-readable description

Example:

"Production webhook"

instance_id
string

Scoped instance ID (null = all instances)

headers
object

Custom HTTP headers sent with each delivery