POST

https://{server-url}

/
webhook
/
set
/
{instance}

Authorizations

​
apikey
string
headerrequired

Your authorization key header

Path Parameters

​
instance
string
required

ID of the instance to connect

Body

application/json
​
enabled
boolean
required

Enables the webhook for this instance

​
url
string
required

Webhook URL

​
events
enum<string>[]
required

Events to be sent to the Webhook

Available options:
APPLICATION_STARTUP,
QRCODE_UPDATED,
MESSAGES_SET,
MESSAGES_UPSERT,
MESSAGES_UPDATE,
MESSAGES_DELETE,
SEND_MESSAGE,
CONTACTS_SET,
CONTACTS_UPSERT,
CONTACTS_UPDATE,
PRESENCE_UPDATE,
CHATS_SET,
CHATS_UPSERT,
CHATS_UPDATE,
CHATS_DELETE,
GROUPS_UPSERT,
GROUP_UPDATE,
GROUP_PARTICIPANTS_UPDATE,
CONNECTION_UPDATE,
LABELS_EDIT,
LABELS_ASSOCIATION,
CALL,
TYPEBOT_START,
TYPEBOT_CHANGE_STATUS
​
webhookByEvents
boolean

Enables Webhook by events

​
webhookBase64
boolean

Sends files in base64 when available

Response

201 - application/json
​
webhook
object
Set PresenceFind Webhook