Skip to main content
PUT
cURL

Path Parameters

instance_id
string
required

Id da instância (dashboard › instância › Credenciais).

token
string
required

Token da instância. Trate como senha.

Body

application/json
received_url
string<uri> | null
delivery_url
string<uri> | null
message_status_url
string<uri> | null
instance_status_url
string<uri> | null

Mudanças de status da instância (qr, connecting, connected, disconnected, logged_out…).

chat_presence_url
string<uri> | null
single_url_enabled
boolean

Com true, todos os eventos vão para single_url e as *_url por tipo são ignoradas.

single_url
string<uri> | null

URL única para todos os eventos (quando single_url_enabled).

notify_sent_by_me
boolean
notify_status
boolean

Com true, também entrega received dos status (stories) publicados pelos contatos, com phone: "status@broadcast". Padrão false.

ignore_groups
boolean
ignore_private
boolean
ignore_text
boolean
ignore_image
boolean
ignore_video
boolean
ignore_audio
boolean
ignore_document
boolean
ignore_received_callback
boolean
ignore_delivery_callback
boolean
ignore_message_status_callback
boolean
ignore_instance_status_callback
boolean
ignore_chat_presence_callback
boolean
use_workspace_webhooks
boolean

Com true, a instância usa as URLs e filtros configurados no workspace (painel › Webhooks) e ignora os campos próprios. As entregas passam a ser assinadas com o secret do workspace. Definir uma URL não nula na instância desliga isso automaticamente, salvo se use_workspace_webhooks vier junto.

Response

Configuração de webhooks após a alteração.

use_workspace_webhooks
boolean
required

Com true, usa as URLs e filtros do workspace (painel › Webhooks) e ignora os campos abaixo. As entregas usam o secret do workspace.

received_url
string | null
required

URL http(s) ou null (desligado).

delivery_url
string | null
required

URL http(s) ou null (desligado).

message_status_url
string | null
required

URL http(s) ou null (desligado).

instance_status_url
string | null
required

URL http(s) ou null (desligado).

chat_presence_url
string | null
required

URL http(s) ou null (desligado).

single_url_enabled
boolean
required

Com true, todos os eventos vão para single_url e as *_url por tipo são ignoradas.

single_url
string | null
required

URL única para todos os eventos (quando single_url_enabled).

notify_sent_by_me
boolean
required
notify_status
boolean
required

Entrega received dos status (stories) dos contatos (status@broadcast).

ignore_groups
boolean
required
ignore_private
boolean
required
ignore_text
boolean
required
ignore_image
boolean
required
ignore_video
boolean
required
ignore_audio
boolean
required
ignore_document
boolean
required
ignore_received_callback
boolean
required
ignore_delivery_callback
boolean
required
ignore_message_status_callback
boolean
required
ignore_instance_status_callback
boolean
required
ignore_chat_presence_callback
boolean
required
secret
string | null
required

Chave HMAC do header X-Wabox-Signature quando a instância usa a própria configuração. null significa entregas não assinadas. Herdando do workspace (use_workspace_webhooks), as entregas usam o secret do workspace.