v1

latestOpenAPI 3.0.3raw.githubusercontent.com2024-06-11720209.3 KB
Webhook Controller

Set Webhook

Set Webhook for instance

post/webhook/set/{instance}

Path parameters

instancestring required

ID of the instance to connect

Request body

urlstring required

Webhook URL

webhook_by_eventsboolean

Enables Webhook by events

webhook_base64boolean

Sends files in base64 when available

eventsstring[] required

Events to be sent to the Webhook

Response

Created

Example response

{
  "webhook": {
    "instanceName": "teste-docs",
    "webhook": {
      "url": "https://example.com",
      "events": [
        "APPLICATION_STARTUP"
      ],
      "enabled": true
    }
  }
}