EVevolution-foundation
Webhook Controller

Set Webhook

Changed on

Set Webhook for instance

post/webhook/set/{instance}

Request

  • Base URL
    https://evolution-example
  • URL
    https://evolution-example/webhook/set/{instance}
  • Auth
    API key in header apikey

Path parameters

instancestring required

Name of the instance

Request body

enabledboolean required

enable webhook to instance

urlstring required

Webhook URL

webhookByEventsboolean required

Enables Webhook by events

webhookBase64boolean required

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
    }
  }
}

Changes

  • v20666de64f49aRevision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • warning

      removed the request property

    • warning

      removed the request property

  • v2c153448703e5Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      removed the success response with the status

    • info

      api operation id setWebhook was added

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      api tag Webhook Controller added

    • info

      api tag Integrations > Events > Webhook removed

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the success response with the status