Skip to main content

El Objeto Webhook

Descripción​

El objeto Webhook representa configuraciones de webhooks para recibir notificaciones desde Verifik hacia tu backend.

Atributos​

client​

Tipo: ObjectId
Requerido: Sí

Referencia al cliente asociado con el webhook. Este es un campo requerido que vincula el webhook a un cliente específico.

projectFlow​

Tipo: Array of ObjectId
Requerido: No

Arreglo de referencias a objetos ProjectFlow. Si no se proporcionan flujos de proyecto, este campo por defecto es un arreglo vacío.

statistics​

Tipo: Object
Requerido: No

Almacena datos estadísticos relacionados con el webhook. Por defecto, este campo es un objeto vacío {}.

isActive​

Tipo: Boolean
Requerido: Sí

Indica si el webhook está activo. Este es un campo requerido y debe establecerse como true o false.

name​

Tipo: String
Requerido: Sí

El nombre del webhook. Este es un campo requerido y debe proporcionarse como una cadena de texto.

url​

Tipo: String
Requerido: Sí

El endpoint URL al que el webhook enviará notificaciones. Este es un campo requerido y debe proporcionarse como una cadena válida.

description​

Tipo: String
Requerido: No

Una breve descripción del webhook. Este es un campo opcional y puede usarse para agregar más contexto o detalles sobre el webhook.

notification​

Tipo: Object
Requerido: No

Contiene configuraciones de notificación para el webhook. El objeto tiene los siguientes subcampos opcionales:

  • email - String - Opcional - Dirección de correo electrónico a la cual se enviarán las notificaciones.
  • success - Boolean - Opcional - Indica si se enviarán notificaciones en eventos exitosos. Por defecto es false.
  • fail - Boolean - Opcional - Indica si se enviarán notificaciones en eventos fallidos. Por defecto es true.

Objeto de Ejemplo​

{
  "client": "613a4b978482f60fd31bd7b7",
  "projectFlow": ["613a4b978482f60fd31bd7b8", "613a4b978482f60fd31bd7b9"],
  "statistics": {},
  "isActive": true,
  "name": "Payment Processor Webhook",
  "url": "https://example.com/webhook-endpoint",
  "description": "This webhook handles payment processing notifications.",
  "notification": {
    "email": "notify@example.com",
    "success": true,
    "fail": false
  }
}

Características​

  • Asociación de cliente: Vincula webhooks a clientes específicos
  • Integración con flujos de proyecto: Conecta webhooks a múltiples flujos de proyecto
  • Configuración de notificaciones: Configura notificaciones por correo para eventos de éxito/fallo
  • Seguimiento estadístico: Monitorea el rendimiento y uso del webhook
  • Configuración flexible: Campos opcionales para descripciones y configuraciones personalizadas