Skip to main content
GET
Consultar webhook

Conceptos

Devuelve los datos de un webhook concreto. Igual que en el listado, las credenciales de autenticación y el secret de firma no se devuelven por seguridad.
El webhookId se obtiene en la respuesta del endpoint Crear webhook o Listar webhooks.

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"

webhookId
string
requerido

ID del webhook

Ejemplo:

"A1B2C3D4E5F6789012345678901234AB"

Respuesta

Datos del webhook

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"