Saltar al contenido principal

Webhooks

Network

Los webhooks permiten que Apostolic Path notifique automáticamente a sus sistemas externos cuando ocurren eventos en la cuenta de su iglesia. Esto habilita integraciones en tiempo real sin necesidad de hacer polling a la API.

¿Qué son los webhooks?​

Un webhook es una llamada HTTP de retorno (callback) — cuando algo ocurre en Apostolic Path (como la incorporación de un nuevo alumno), la plataforma envía una solicitud POST a una URL que usted especifica, con los detalles del evento.

Crear un webhook​

  1. Navegue a Configuración > Webhooks
  2. Haga clic en Crear webhook
  3. Configure el webhook:
    • URL — El endpoint que recibirá los eventos del webhook
    • Eventos — Seleccione qué eventos deben activar el webhook
  4. Haga clic en Crear

Eventos disponibles​

Puede suscribirse a eventos como:

  • Alumno creado — Se ha añadido un nuevo alumno
  • Alumno actualizado — La información de un alumno ha cambiado
  • Hito completado — Se ha registrado un hito de El Nuevo Nacimiento
  • Primer Paso completado — Un alumno completa un Primer Paso
  • Estudio creado/actualizado — Cambios en Estudios Bíblicos
  • Inscripción a clase — Un alumno se inscribe en una clase
  • Asistencia registrada — Se guarda la asistencia a una clase

Seguridad de los webhooks​

Todos los webhooks se firman con HMAC (Hash-based Message Authentication Code), para que pueda verificar que las solicitudes entrantes provienen realmente de Apostolic Path:

  1. Cuando crea un webhook, se genera un secreto de firma
  2. Cada solicitud de webhook incluye un encabezado de firma
  3. Su aplicación debe verificar la firma usando el secreto compartido

Confiabilidad de los webhooks​

Apostolic Path garantiza una entrega confiable de los webhooks:

  • Reintentos automáticos — Si su endpoint devuelve un error, el webhook se reintenta con retroceso exponencial (exponential backoff)
  • Desactivación automática — Si un webhook falla de forma constante, se desactivará automáticamente para evitar carga innecesaria
  • Registros de entrega — Vea el estado de entrega de los eventos de webhook recientes

Probar un webhook​

Después de crear un webhook, puede enviar un evento de prueba para verificar que su endpoint está recibiendo y procesando los eventos correctamente:

  1. Encuentre el webhook en su lista
  2. Haga clic en Probar
  3. Se enviará un evento de muestra a su URL
  4. Verifique el estado de entrega para confirmar que se recibió

Gestionar webhooks​

  • Editar un webhook para cambiar su URL o los eventos suscritos
  • Deshabilitar un webhook temporalmente sin eliminarlo
  • Eliminar un webhook para quitarlo permanentemente
  • Ver registros para ver los intentos de entrega recientes y sus estados