Skip to main content
GET
Detalhar webhook de template

Conceituação

Retorna os dados de um webhook de template específico do tenant. Assim como na listagem, as credenciais de autenticação e o secret não são retornados por segurança.
Este endpoint requer a role ENTERPRISE na sua conta.
O webhookId é obtido no retorno do endpoint Criar webhook de template ou Listar webhooks de template.

Autorizações

Authorization
string
header
obrigatório

Secret Key gerada no painel de Segurança do Hub Message

Parâmetros de caminho

webhookId
string
obrigatório

ID do webhook de template

Exemplo:

"8F2C00000000000000000000000000A1"

Resposta

Dados do webhook de template

id
string

ID único do webhook de template

Exemplo:

"8F2C00000000000000000000000000A1"

channelId
string | null

Sempre null para webhooks de template

Exemplo:

null

instanceId
string | null
obsoleto

Descontinuado e sempre null para webhooks de template

Exemplo:

null

url
string

URL de destino dos eventos

Exemplo:

"https://destino/webhook"

description
string | null

Descrição do webhook

Exemplo:

"Webhook de template"

events
enum<string>[]

Eventos de template configurados

Eventos de template aceitos: UPDATE_TEMPLATE_STATUS (atualização de status do template — aprovado/rejeitado etc.) e UPDATE_TEMPLATE_CATEGORY (atualização de categoria do template).

Opções disponíveis:
UPDATE_TEMPLATE_STATUS,
UPDATE_TEMPLATE_CATEGORY
Exemplo:
status
enum<string>

Status atual do webhook

Opções disponíveis:
ENABLED,
DISABLED
Exemplo:

"ENABLED"

signing
boolean

Indica se a assinatura HMAC está habilitada

Exemplo:

false

auth
object

Resumo da autenticação configurada — credenciais não são retornadas por segurança

payloadFormat
enum<string>

Sempre DEFAULT para webhooks de template

Opções disponíveis:
DEFAULT
Exemplo:

"DEFAULT"

customAttributes
object
Exemplo:
createdAt
string<date-time>
Exemplo:

"2026-07-15T19:00:00.000+00:00"

updatedAt
string<date-time>
Exemplo:

"2026-07-15T19:00:00.000+00:00"