Un webhook envía un mensaje a una dirección propia cada vez que ocurre algo en su espacio de trabajo, por ejemplo cuando se paga un pedido o se cancela una suscripción. Úselo para mantener sincronizado otro sistema, como una herramienta tipo Zapier, su contabilidad o su propio servidor.
Abrir la configuración de webhooks
Antes de empezar
La página está en Pagos > Configuraciones > Webhooks, en el grupo Desarrolladores. Para verla necesita Ver pagos. Para añadir, modificar, probar y eliminar endpoints necesita Actualizar pedidos / clientes.
Añadir un endpoint
Haga clic en el botón de añadir para abrir Añadir endpoint de webhook:
- En Endpoint, dele un Nombre opcional e introduzca la URL del Endpoint. La dirección debe ser accesible desde internet. Las direcciones de una red privada se rechazan.
- En Eventos, elija lo que debe recibir el endpoint. Buscar eventos acota la lista, la casilla de un grupo selecciona el grupo entero, y Seleccionar todo o Borrar todo cambia todo a la vez. Se necesita al menos un evento.
- Haga clic en Crear.
Los eventos se agrupan por tema:
- Pagos: Pedido pagado, Pago en curso, Pago fallido, Factura pagada, Reembolso creado.
- Suscripciones: Suscripción creada, Suscripción renovada, Suscripción cancelada, Pago de suscripción fallido.
- Miembros: registros, inicios de sesión, etiquetas añadidas o quitadas, campos de miembro modificados y contactos nuevos.
- Cursos y eventos, Comunidad y Datos y bandeja de entrada: cursos y lecciones completados, inscripciones y asistencia a eventos, publicaciones, niveles, insignias, mensajes de la bandeja de entrada y tickets.
- Afiliado: comisiones nuevas y pagos a socios realizados. Consulte la ayuda de afiliados.
El secreto de firma
Justo después de crear el endpoint, el espacio de trabajo muestra su secreto de firma una sola vez: Copie ahora su secreto de firma. Guárdelo en su sistema y después haga clic en Hecho. No se vuelve a mostrar.
Cada entrega se envía como JSON con el encabezado X-Maio-Signature. Contiene un
HMAC-SHA256 del cuerpo bruto de la solicitud, generado con su secreto, como cadena hexadecimal
en minúsculas. Calcule el mismo valor en su sistema y compárelo, así sabrá que el
mensaje procede de su espacio de trabajo. Los encabezados X-Maio-Event y
X-Maio-Delivery indican el evento y la entrega.
Para sustituir el secreto, abra el endpoint y haga clic en Rotar secreto. El secreto anterior deja de funcionar de inmediato, así que actualice su endpoint enseguida.
Probar
Abra el endpoint y haga clic en Enviar prueba. El botón cambia a Prueba en cola, y un evento de prueba llega a su endpoint en unos instantes. Aparece en el registro de entregas como cualquier otra entrega.
El registro de entregas
La pestaña Registro de entregas enumera cada entrega con su Evento, Endpoint, Estado, el estado HTTP con el que respondió su endpoint, los Intentos y Cuándo. Fíltrelo por Entregado, Fallido o Pendiente. La sección Entregas de un endpoint muestra sus 20 entregas más recientes, con el error de cada una que haya fallado.
Una entrega cuenta como entregada cuando su endpoint responde con un estado 2xx en un plazo de 15 segundos. Si no, se vuelve a intentar después de 30 segundos, 5 minutos, 30 minutos, 2 horas y 6 horas. Reenviar envía una entrega de nuevo con el mismo contenido.
Después de 20 intentos fallidos seguidos para un evento, ese evento se desactiva para el endpoint. Si el endpoint responde con 410 Gone, el evento se desactiva de inmediato. Corrija el endpoint y después vuelva a ponerlo en Activo.
Desactivar y eliminar
En el endpoint, el interruptor alterna entre Activo y Deshabilitado. Un endpoint deshabilitado no recibe nada. Eliminar lo borra con todos sus eventos después de que usted lo confirme.
Desde la API
Las apps conectadas mediante la API pueden configurar sus propios endpoints con los endpoints
/api/v1/hooks y una clave de API con el alcance webhooks:manage.
Aparecen en la lista con una insignia API, y aquí solo se pueden cambiar su nombre y su estado.
No tienen Rotar secreto ni Enviar prueba. Consulte
Claves de API y acceso para desarrolladores.