Saltar al contenido principal
GET
Listar webhooks predeterminados

Conceptos

Devuelve los webhooks predeterminados del workspace de la secret key, habilitados y deshabilitados. Los webhooks de canal y los webhooks de plantilla no aparecen en esta lista. El campo auth.configured indica si hay una credencial de autenticación configurada, pero la credencial en sí no se devuelve. El secret de la firma HMAC tampoco se devuelve: solo aparece en la respuesta que lo generó.

Autorizaciones

Authorization
string
header
requerido

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

Respuesta

Webhooks predeterminados del workspace

id
string

ID del webhook predeterminado

Ejemplo:

"5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B"

channelId
string | null

Siempre null: el webhook predeterminado no pertenece a un canal

Ejemplo:

null

instanceId
string | null
obsoleto

Siempre null. Campo heredado, mantenido por compatibilidad

Ejemplo:

null

url
string
Ejemplo:

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

description
string | null
Ejemplo:

"Eventos de todos los canales"

events
enum<string>[]
Opciones disponibles:
MESSAGE_RECEIVED,
MESSAGE_DELIVERY,
MESSAGE_STATUS,
RECEIVED_STATUS,
RECEIVED_AND_DELIVERY,
CONNECTED,
DISCONNECTED,
PRESENCE_CHAT,
INITIAL_DATA,
BLOCK
status
enum<string>

ENABLED o DISABLED

Opciones disponibles:
ENABLED,
DISABLED
signing
boolean

true cuando la firma HMAC está activa

auth
object

Resumen de la autenticación configurada. Las credenciales no se devuelven.

payloadFormat
enum<string>
Opciones disponibles:
DEFAULT,
Z_API
customAttributes
object
createdAt
string<date-time>

Fecha de creación

updatedAt
string<date-time>

Fecha de la última modificación