The Webhook object (El objeto de Webhook)

Los webhooks se utilizan para enviar información desde nuestro backend a tu backend a través de una URL que puedes configurar durante la creación de un proyecto/projectFlow.

Atributos

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

projectFlow - Array of ObjectId - Optional Array de referencias a objetos ProjectFlow. Si no se proporcionan flujos de proyecto, este campo se establece por defecto como un array vacío.

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

isActive - Boolean - Required Indica si el webhook está activo. Este es un campo requerido y debe establecerse entrue or false.

name - String - Required El nombre del webhook. Este es un campo requerido y debe proporcionarse como una cadena de texto (string).

url - String - Required El URL endpoint al que el webhook enviará notificaciones. Este es un campo requerido y debe proporcionarse como una cadena de texto (string) válida.

description - String - Optional 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 - Object - Optional

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 que se enviarán las notificaciones.

  • success - Boolean - Opcional Indica si se deben enviar notificaciones en eventos exitosos. Por defecto es false.

  • fail - Boolean - Opcional Indica si se deben enviar notificaciones en eventos fallidos. Por defecto es true.

.

The Webhook object

{
  "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
  }
}
PreviousWebhooksNextCreate a Webhook (Crear un Webhook)

Last updated