Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

API key do workspace (painel › Segurança › API keys), enviada em Authorization: Bearer wbx_key_…. Cada key tem permissões. As rotas /account/* pedem a permissão da rota. Nas rotas de instância, a key só é exigida quando o workspace liga "Exigir API key" e precisa de instances:operate.

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

Response

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

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 X-Wabox-Signature para toda instância que herda esta configuração (use_workspace_webhooks). Gerada no primeiro PUT.

configured
boolean
required

false até o primeiro PUT (nada a herdar ainda).

used_by_instances
integer
required

Instâncias ativas que herdam esta configuração no momento.

Required range: -9007199254740991 <= x <= 9007199254740991