Set Webhook

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": []
}
'

import requests

url = "https://{server-url}/webhook/set/{instance}"

payload = {
    "enabled": True,
    "url": "<string>",
    "webhookByEvents": True,
    "webhookBase64": True,
    "events": []
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    url: '<string>',
    webhookByEvents: true,
    webhookBase64: true,
    events: []
  })
};

fetch('https://{server-url}/webhook/set/{instance}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{server-url}/webhook/set/{instance}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'url' => '<string>',
    'webhookByEvents' => true,
    'webhookBase64' => true,
    'events' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{server-url}/webhook/set/{instance}"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"url\": \"<string>\",\n  \"webhookByEvents\": true,\n  \"webhookBase64\": true,\n  \"events\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{server-url}/webhook/set/{instance}")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"url\": \"<string>\",\n  \"webhookByEvents\": true,\n  \"webhookBase64\": true,\n  \"events\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{server-url}/webhook/set/{instance}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"url\": \"<string>\",\n  \"webhookByEvents\": true,\n  \"webhookBase64\": true,\n  \"events\": []\n}"

response = http.request(request)
puts response.read_body

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

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": []
}
'

import requests

url = "https://{server-url}/webhook/set/{instance}"

payload = {
    "enabled": True,
    "url": "<string>",
    "webhookByEvents": True,
    "webhookBase64": True,
    "events": []
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    url: '<string>',
    webhookByEvents: true,
    webhookBase64: true,
    events: []
  })
};

fetch('https://{server-url}/webhook/set/{instance}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{server-url}/webhook/set/{instance}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'url' => '<string>',
    'webhookByEvents' => true,
    'webhookBase64' => true,
    'events' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{server-url}/webhook/set/{instance}"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"url\": \"<string>\",\n  \"webhookByEvents\": true,\n  \"webhookBase64\": true,\n  \"events\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{server-url}/webhook/set/{instance}")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"url\": \"<string>\",\n  \"webhookByEvents\": true,\n  \"webhookBase64\": true,\n  \"events\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{server-url}/webhook/set/{instance}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"url\": \"<string>\",\n  \"webhookByEvents\": true,\n  \"webhookBase64\": true,\n  \"events\": []\n}"

response = http.request(request)
puts response.read_body

{
  "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 array length: 1

Available options:

APPLICATION_STARTUP,

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,

TYPEBOT_START,

TYPEBOT_CHANGE_STATUS

Response

201 - application/json

Created

webhook

object

Show child attributes

Início

Instances

Webhook

Settings

Send Message

Chat Controller

Profile Settings

Group Controller

Typebot

OpenAI

Evolution Bot

Dify

n8n

EvoAI

Flowise

Chatwoot

Websocket

SQS

RabbitMQ

Authorizations

Path Parameters

Body

Response