Saltar al contenido principal
GET
Consultar webhook predeterminado

Conceptos

Devuelve los datos de un webhook predeterminado del workspace. Igual que en el listado, las credenciales de autenticación y el secret no se devuelven. Un id de otro workspace, de un webhook de canal o de un webhook de plantilla recibe 404, la misma respuesta que un id que no existe.
El webhookId se obtiene en la respuesta de Crear webhook predeterminado o de Listar webhooks predeterminados.

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de ruta

webhookId
string
requerido

ID del webhook predeterminado

Ejemplo:

"5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B"

Respuesta

Webhook predeterminado encontrado

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