Skip to main content
GET
Listar webhooks

Conceptos

Devuelve todos los webhooks registrados en un canal. El campo auth.configured indica si hay credenciales de autenticación definidas, pero las credenciales en sí no se devuelven por seguridad. El campo secret (firma HMAC) tampoco se devuelve en el listado: solo está disponible en el momento de la creación o de la actualización con signing: true.

Autorizaciones

Authorization
string
header
requerido

Secret Key generada en el panel de Seguridad de Omni Z-API

Parámetros de ruta

channelId
string
requerido

ID del canal

Ejemplo:

"019E4C54B1B375A28970B605CA9B03C3"

Respuesta

Lista de webhooks del canal

id
string

ID único del webhook

Ejemplo:

"A1B2C3D4E5F6789012345678901234AB"

channelId
string

ID del canal al que pertenece el webhook

Ejemplo:

"019E4C54B1B375A28970B605CA9B03C3"

instanceId
string
obsoleto

Obsoleto: usa channelId

Ejemplo:

"019E4C54B1B375A28970B605CA9B03C3"

url
string

URL de destino de los eventos

Ejemplo:

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

description
string | null

Descripción del webhook

Ejemplo:

"Webhook principal de producción"

events
string[]

Tipos de evento configurados

Ejemplo:
status
enum<string>

Estado actual del webhook

Opciones disponibles:
ENABLED,
DISABLED
Ejemplo:

"ENABLED"

signing
boolean

Indica si la firma HMAC está habilitada

Ejemplo:

true

auth
object

Resumen de la autenticación configurada: las credenciales no se devuelven por seguridad

payloadFormat
enum<string>

Formato del payload entregado

Opciones disponibles:
DEFAULT,
Z_API,
CHATWOOT
Ejemplo:

"DEFAULT"

customAttributes
object

Atributos extra configurados

Ejemplo:
createdAt
string<date-time>

Fecha de creación

Ejemplo:

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

updatedAt
string<date-time>

Fecha de la última actualización

Ejemplo:

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