Skip to main content
GET
Listar webhooks de plantilla

Conceptos

Devuelve los webhooks de plantilla habilitados del tenant, limitados al alcance del Authorization: no hay acceso cross-tenant. Las credenciales de autenticación y el secret de firma no se devuelven por seguridad.

Autorizaciones

Authorization
string
header
requerido

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

Respuesta

Lista de webhooks de plantilla del tenant

id
string

ID único del webhook de plantilla

Ejemplo:

"8F2C00000000000000000000000000A1"

channelId
string | null

Siempre null en los webhooks de plantilla

Ejemplo:

null

instanceId
string | null
obsoleto

Obsoleto y siempre null en los webhooks de plantilla

Ejemplo:

null

url
string

URL de destino de los eventos

Ejemplo:

"https://destino/webhook"

description
string | null

Descripción del webhook

Ejemplo:

"Webhook de plantilla"

events
enum<string>[]

Eventos de plantilla configurados

Eventos de plantilla admitidos: UPDATE_TEMPLATE_STATUS (actualización del estado de la plantilla: aprobada, rechazada, etc.) y UPDATE_TEMPLATE_CATEGORY (actualización de la categoría de la plantilla).

Opciones disponibles:
UPDATE_TEMPLATE_STATUS,
UPDATE_TEMPLATE_CATEGORY
Ejemplo:
status
enum<string>

Estado actual del webhook

Opciones disponibles:
ENABLED,
DISABLED
Ejemplo:

"ENABLED"

signing
boolean

Indica si la firma HMAC está habilitada

Ejemplo:

false

auth
object

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

payloadFormat
enum<string>

Siempre DEFAULT en los webhooks de plantilla

Opciones disponibles:
DEFAULT
Ejemplo:

"DEFAULT"

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

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

updatedAt
string<date-time>
Ejemplo:

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