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

Authorizations

apikey
string
header
required

Your authorization key header

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

Minimum length: 1

Response

201 - application/json

Created

webhook
object