POST HTTPS a su URL cuando ocurre algo en un negocio, así sus herramientas no necesitan consultar la API una y otra vez.
Eventos
data tiene la misma forma que el recurso de la API correspondiente. Por ejemplo, GET /appointments devuelve los objetos que incluye un evento appointment.booked, así que un endpoint de lista también sirve como datos de ejemplo.
Agregue un endpoint
Puede agregar endpoints en el panel o con la API.- Panel
- API
1
Abra Webhooks
Vaya a Integraciones y haga clic en Gestionar en la tarjeta Webhooks. Solo los propietarios y administradores pueden gestionar los webhooks.
2
Agregue el endpoint
Haga clic en Agregar endpoint, introduzca la URL y elija los eventos.
3
Copie el secreto de firma
LobbyStack muestra el secreto
whsec_ una sola vez. Guárdelo donde su endpoint pueda leerlo.4
Envíe un evento de prueba
Haga clic en Enviar evento de prueba y luego abra Registro de entregas para ver la respuesta que devolvió su endpoint.
Carga útil
data refleja el recurso en el momento en que ocurrió el evento. Vuelva a consultar el recurso si necesita su estado actual.
Verifique las firmas
LobbyStack firma cada solicitud con el esquema Standard Webhooks y envía tres encabezados:
La firma abarca
{webhook-id}.{webhook-timestamp}.{raw body}, con la parte del secreto posterior a whsec_, decodificada en base64, como clave. Use una biblioteca de Standard Webhooks para comprobarla con el cuerpo sin procesar de la solicitud, antes de analizar el JSON:
Responda y reintente
Devuelva cualquier estado2xx en un plazo de 10 segundos. LobbyStack considera cualquier otra cosa como un fallo, incluidos los tiempos de espera agotados, las redirecciones y los errores de conexión. No sigue las redirecciones.
Después de un fallo, LobbyStack reintenta al cabo de 30 segundos, 2 minutos, 10 minutos, 30 minutos, 1 hora, 3 horas, 6 horas y 12 horas, con un total de 9 intentos en unas 23 horas. Cada intento usa el mismo webhook-id, así que elimine los duplicados a partir de él. Los eventos pueden llegar desordenados; compare created_at o vuelva a consultar el recurso si el orden importa.
Si un evento falla en todos los intentos y nada llegó al endpoint durante ese tiempo, LobbyStack desactiva el endpoint y avisa a su equipo, según las preferencias de cada persona en Configuración > Notificaciones. Corrija el endpoint, vuelva a activarlo en el panel o con PATCH /webhooks/{webhook_id} y {"status": "enabled"}, y luego use Reenviar en el registro de entregas para enviar los eventos perdidos.
Registro de entregas
El registro de entregas muestra cada evento enviado a un endpoint, su estado, el último código de respuesta, el número de intentos y cuándo se hará el próximo reintento. Reenviar vuelve a enviar un evento. LobbyStack conserva 30 días de historial de webhooks.Cambie el secreto
Haga clic en Cambiar secreto en el endpoint. El secreto anterior deja de funcionar de inmediato. Actualice su endpoint con el nuevo secreto poco después: los eventos que no pasen la verificación mientras tanto se reintentan y llegan en cuanto su endpoint use el nuevo secreto.Reglas de red
Los endpoints deben usarhttps:// y resolverse en una dirección pública. LobbyStack rechaza las URL que apuntan a direcciones privadas, de loopback, de enlace local o de metadatos de la nube, tanto al guardar el endpoint como en cada entrega. Las implementaciones autoalojadas siguen la misma regla.