Skip to main content
PUT
On connect

Overview

This is the phone connection callback webhook with Z-API. It’s triggered when Z-API connects to WhatsApp — during QR code reading, instance restart, etc.
Z-API does not accept webhooks that are not HTTPS.

Update webhook

string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.

Body

string
required
Connection webhook URL

Request Body


Webhook callback

string
Event type: ConnectedCallback
boolean
Instance connection status
string
Connected phone number
integer
Connection timestamp
string
Instance identifier

Response

200

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or PUT as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.