Skip to main content
GET
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.

Response

Configuração de webhooks.

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