Pular para o conteúdo principal
GET
Detalhar webhook padrão

Conceituação

Retorna os dados de um webhook padrão do workspace. Assim como na listagem, as credenciais de autenticação e o secret não são retornados. Um id de outro workspace, de um webhook de canal ou de um webhook de template recebe 404, a mesma resposta de um id que não existe.
O webhookId é obtido no retorno do endpoint Criar webhook padrão ou Listar webhooks padrão.

Autorizações

Authorization
string
header
obrigatório

Secret Key gerada no painel de Segurança do Omni Z-API

Parâmetros de caminho

webhookId
string
obrigatório

ID do webhook padrão

Exemplo:

"5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B"

Resposta

Webhook padrão encontrado

id
string

ID do webhook padrão

Exemplo:

"5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B"

channelId
string | null

Sempre null: o webhook padrão não pertence a um canal

Exemplo:

null

instanceId
string | null
obsoleto

Sempre null. Campo legado, mantido por compatibilidade

Exemplo:

null

url
string
Exemplo:

"https://app.suaempresa.com/webhooks/omni-zapi"

description
string | null
Exemplo:

"Eventos de todos os canais"

events
enum<string>[]
Opções disponíveis:
MESSAGE_RECEIVED,
MESSAGE_DELIVERY,
MESSAGE_STATUS,
RECEIVED_STATUS,
RECEIVED_AND_DELIVERY,
CONNECTED,
DISCONNECTED,
PRESENCE_CHAT,
INITIAL_DATA,
BLOCK
status
enum<string>

ENABLED ou DISABLED

Opções disponíveis:
ENABLED,
DISABLED
signing
boolean

true quando a assinatura HMAC está ligada

auth
object

Resumo da autenticação configurada. As credenciais não são retornadas.

payloadFormat
enum<string>
Opções disponíveis:
DEFAULT,
Z_API
customAttributes
object
createdAt
string<date-time>

Data de criação

updatedAt
string<date-time>

Data da última alteração