Skip to main content
POST
/
webhook
/
set
/
{instance}
Set Webhook
curl --request POST \
  --url https://api.botifiy.com/webhook/set/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "enabled": true,
  "url": "<string>",
  "webhookByEvents": true,
  "webhookBase64": true,
  "events": []
}
'
{
  "webhook": {
    "instanceName": "<string>",
    "webhook": {
      "enabled": true,
      "url": "<string>",
      "events": [
        "<string>"
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.botifiy.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
apikey
string
header
required

Path Parameters

​
instance
string
required

Name of the instance

Body

application/json
​
enabled
boolean
required

enable webhook to instance

​
url
string
required

Webhook URL

​
webhookByEvents
boolean
required

Enables Webhook by events

​
webhookBase64
boolean
required

Sends files in base64 when available

​
events
enum<string>[]
required

Events to be sent to the Webhook

Available options:
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,
CALL,
NEW_JWT_TOKEN

Response

201 - application/json

Created

​
webhook
object