.env
file with global events/webhook/instance
endpointParameter | Type | Required | Description |
---|---|---|---|
enabled | boolean | Yes | Enter “true” to create or change Webhook data, or “false” if you want to stop using it. |
url | string | Yes | Webhook URL to receive event data. |
webhook_by_events | boolean | No | Whether to generate a specific Webhook URL for each of your events. |
events | array | No | List of events to be processed. If you don’t want to use some of these events, simply remove them from the list. |
Environment Variable | URL | Description |
---|---|---|
APPLICATION_STARTUP | /application-startup | Notifies when an application startup occurs |
QRCODE_UPDATED | /qrcode-updated | Sends the QR code in base64 format for scanning |
CONNECTION_UPDATE | /connection-update | Informs the status of the WhatsApp connection |
MESSAGES_SET | /messages-set | Sends a list of all messages loaded in WhatsApp. This event occurs only once |
MESSAGES_UPSERT | /messages-upsert | Notifies when a message is received |
MESSAGES_UPDATE | /messages-update | Informs when a message is updated |
MESSAGES_DELETE | /messages-delete | Informs when a message is deleted |
SEND_MESSAGE | /send-message | Notifies when a message is sent |
CONTACTS_SET | /contacts-set | Performs the initial loading of all contacts. This event occurs only once |
CONTACTS_UPSERT | /contacts-upsert | Reloads all contacts with additional information. This event occurs only once |
CONTACTS_UPDATE | /contacts-update | Informs when a contact is updated |
PRESENCE_UPDATE | /presence-update | Informs if the user is online, performing an action such as typing or recording, and their last seen status: ‘unavailable’, ‘available’, ‘typing’, ‘recording’, ‘paused’ |
CHATS_SET | /chats-set | Sends a list of all loaded chats |
CHATS_UPDATE | /chats-update | Informs when a chat is updated |
CHATS_UPSERT | /chats-upsert | Sends any new chat information |
CHATS_DELETE | /chats-delete | Notifies when a chat is deleted |
GROUPS_UPSERT | /groups-upsert | Notifies when a group is created |
GROUPS_UPDATE | /groups-update | Notifies when a group has its information updated |
GROUP_PARTICIPANTS_UPDATE | /group-participants-update | Notifies when an action occurs involving a participant: ‘add’, ‘remove’, ‘promote’, ‘demote’ |
NEW_TOKEN | /new-jwt | Notifies when the token (jwt) is updated |
https://sub.domain.com/webhook/
. Evolution will automatically add the event name to the end of the URL when webhook_by_events
is set to true.
Method | Endpoint |
---|---|
GET | [baseUrl]/webhook/find/[instance] |