Pular para o conteúdo principal
GET
/
v1
/
channels
/
{channelId}
/
webhooks
Listar webhooks
curl --request GET \
  --url https://api.hubmessage.io/v1/channels/{channelId}/webhooks \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "A1B2C3D4E5F6789012345678901234AB",
    "instanceId": "019E4C54B1B375A28970B605CA9B03C3",
    "url": "https://app.suaempresa.com/webhooks/hubmessage",
    "description": "Webhook principal de produção",
    "events": [
      "MESSAGE_RECEIVED",
      "MESSAGE_STATUS"
    ],
    "status": "ENABLED",
    "signing": true,
    "auth": {
      "type": "BEARER",
      "configured": true
    },
    "payloadFormat": "DEFAULT",
    "customAttributes": {},
    "createdAt": "2025-01-15T10:30:00.000+0000",
    "updatedAt": "2025-01-15T10:30:00.000+0000"
  },
  {
    "id": "B2C3D4E5F6789012345678901234AB12",
    "instanceId": "019E4C54B1B375A28970B605CA9B03C3",
    "url": "https://app.suaempresa.com/webhooks/eventos-conexao",
    "description": "Eventos de conexão",
    "events": [
      "CONNECTED",
      "DISCONNECTED"
    ],
    "status": "ENABLED",
    "signing": false,
    "auth": {
      "type": "NONE",
      "configured": false
    },
    "payloadFormat": "DEFAULT",
    "customAttributes": {},
    "createdAt": "2025-01-16T08:00:00.000+0000",
    "updatedAt": "2025-01-16T08:00:00.000+0000"
  }
]

​
Conceituação

Retorna todos os webhooks cadastrados em um canal. O campo auth.configured indica se credenciais de autenticação estão definidas, mas as credenciais em si não são retornadas por segurança. O campo secret (assinatura HMAC) também não é retornado na listagem — ele só está disponível no momento da criação ou atualização com signing: true.
Este endpoint requer a role ENTERPRISE na sua conta.

Autorizações

​
Authorization
string
header
obrigatório

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

Parâmetros de caminho

​
channelId
string
obrigatório

ID do canal

Exemplo:

"019E4C54B1B375A28970B605CA9B03C3"

Resposta

Lista de webhooks do canal

​
id
string

ID único do webhook

Exemplo:

"A1B2C3D4E5F6789012345678901234AB"

​
instanceId
string

ID do canal ao qual o webhook pertence

Exemplo:

"019E4C54B1B375A28970B605CA9B03C3"

​
url
string

URL de destino dos eventos

Exemplo:

"https://app.suaempresa.com/webhooks/hubmessage"

​
description
string | null

Descrição do webhook

Exemplo:

"Webhook principal de produção"

​
events
string[]

Tipos de evento configurados

Exemplo:
["MESSAGE_RECEIVED", "MESSAGE_STATUS"]
​
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:

true

​
auth
object

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

​
payloadFormat
enum<string>

Formato do payload entregue

Opções disponíveis:
DEFAULT,
Z_API
Exemplo:

"DEFAULT"

​
customAttributes
object

Atributos extras configurados

Exemplo:
{}
​
createdAt
string<date-time>

Data de criação

Exemplo:

"2025-01-15T10:30:00.000+0000"

​
updatedAt
string<date-time>

Data da última atualização

Exemplo:

"2025-01-15T10:30:00.000+0000"