Saltar al contenido principal

Configuración de webhooks Growth+This feature requires the Growth+ plan or higher

Los webhooks permiten que aplicaciones externas reciban notificaciones en tiempo real cuando algo sucede en su cuenta de EquipDash. En lugar de consultar la API repetidamente, su aplicación recibe una solicitud HTTP POST instantánea cada vez que ocurre un evento seleccionado.


Crear un endpoint de webhook​

  1. Haga clic en Configuración en la barra lateral.
  2. Seleccione API e integraciones en el menú de configuración.
  3. Haga clic en la pestaña Webhooks.
  4. Haga clic en + Crear webhook.
  5. Complete lo siguiente:
    • Nombre -- una etiqueta descriptiva (por ejemplo, "Sincronización contable", "Notificaciones de Slack").
    • URL -- la URL del endpoint al que EquipDash debe enviar los datos del webhook (debe ser HTTPS).
    • Eventos -- seleccione qué eventos deben activar este webhook (consulte la tabla de eventos a continuación).
    • Activo -- active esta opción para empezar a recibir eventos de inmediato.
  6. Haga clic en Crear.

La pestaña Webhooks en la página de configuración de API e integraciones


Secreto del webhook​

Después de crear un webhook, EquipDash genera un secreto del webhook. Este secreto se usa para verificar que las solicitudes entrantes realmente provienen de EquipDash.

  1. Copie el secreto de inmediato y guárdelo de forma segura.
  2. Use el secreto para validar el encabezado X-Webhook-Signature en las solicitudes entrantes.
precaución

El secreto del webhook se muestra solo una vez, al crear el webhook. Si lo pierde, puede regenerarlo desde la página de detalles del webhook, pero deberá actualizar su aplicación con el nuevo secreto.


Eventos de webhook disponibles​

Reservas​

EventoSe activa cuando
booking.createdSe crea una nueva reserva
booking.updatedSe modifica una reserva
booking.cancelledSe cancela una reserva
booking.completedUna reserva se marca como completada

Pagos​

EventoSe activa cuando
payment.receivedSe registra un pago
payment.refundedSe procesa un reembolso

Clientes​

EventoSe activa cuando
customer.createdSe agrega un nuevo cliente
customer.updatedSe modifica el registro de un cliente
customer.deletedSe elimina un cliente

Productos​

EventoSe activa cuando
product.createdSe agrega un nuevo producto
product.updatedSe modifica un producto
product.archivedSe archiva un producto

Experiencias​

EventoSe activa cuando
experience.createdSe agrega una nueva experiencia
experience.updatedSe modifica una experiencia
experience.archivedSe archiva una experiencia

Formularios​

EventoSe activa cuando
form_response.submittedUn cliente envía un formulario o exención de responsabilidad

Vales​

EventoSe activa cuando
voucher.soldSe compra un vale o tarjeta de regalo
voucher.redeemedSe usa un vale en una reserva

Administrar webhooks​

Desde la pestaña Webhooks, puede:

  • Editar un webhook para cambiar su nombre, URL o los eventos seleccionados.
  • Pausar un webhook desactivándolo. Mientras esté pausado, no se enviarán eventos.
  • Regenerar secreto si el secreto de su webhook ha sido comprometido.
  • Eliminar un webhook para quitarlo permanentemente.

Verificar las firmas de los webhooks​

Cada solicitud de webhook incluye un encabezado X-Webhook-Signature. Para verificar que la solicitud es auténtica:

  1. Calcule un hash HMAC-SHA256 del cuerpo de la solicitud usando su secreto de webhook.
  2. Compare el hash calculado con el valor del encabezado X-Webhook-Signature.
  3. Si coinciden, la solicitud es auténtica.

Esto evita que atacantes envíen eventos de webhook falsos a su endpoint.