Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

Response

Configuração 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

true = todos os eventos vão para single_url; 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 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