Recibir eventos en un webhook

Recibe los eventos de negocio de los productos Lerian en tu propio endpoint HTTPS, cada uno firmado por Streaming Hub.

Participantes

Tu institución. Tu sistema llama a la API de Streaming Hub con un token de Access Manager. Tu endpoint HTTPS recibe las entregas.
Streaming Hub. El servicio de plataforma de Lerian que asocia cada evento con tus suscripciones y lo entrega. Lerian lo configura para tu institución.
Producto Lerian. El producto que publica el evento de negocio, por ejemplo Midaz.

Diagrama

Pasos

#	Origen	Destino	Mensaje	API de Lerian	Qué ocurre
1	Tu institución	Streaming Hub	API de Lerian	`GET /v1/catalog`	Lee los eventos a los que te puedes suscribir.
2	Streaming Hub	Tu institución	Respuesta		El catálogo da a cada evento su `eventKey`. Pon ese valor en `event_types` exactamente como lo da el catálogo.
3	Tu institución	Streaming Hub	API de Lerian	`POST /v1/subscriptions`	Crea la suscripción con un `name`, `sink_kind` `webhook`, tu endpoint `https://` y los `event_types` que quieres. Envía un header `X-Idempotency` único.
4	Streaming Hub	Tu institución	Respuesta		La respuesta trae la suscripción en `pending_verification` y el `signingSecret`. Guarda el secreto ahora. Ninguna ruta de lectura lo devuelve.
5	Tu institución	Streaming Hub	API de Lerian	`POST /v1/subscriptions/{id}/ping`	Pide a Streaming Hub que pruebe tu endpoint.
6	Streaming Hub	Tu institución	Webhook	Evento `hub.subscription.verification_ping`	Streaming Hub envía un evento de prueba firmado a tu endpoint.
7	Tu institución	Streaming Hub	Respuesta		Tu endpoint verifica la firma con el secreto y responde `2xx`.
8	Streaming Hub	Tu institución	Respuesta		El ping responde `outcome` `ok`. La suscripción ahora está `active`.
9	Producto Lerian	Streaming Hub	Evento		El producto publica un evento de negocio.
10	Streaming Hub	Streaming Hub	Paso interno		Streaming Hub asocia el evento con tus suscripciones activas que lo piden.
11	Streaming Hub	Tu institución	Webhook	Los eventos en `event_types`	Streaming Hub envía el evento a tu endpoint, firmado con tu secreto.
12	Tu institución	Streaming Hub	Respuesta		Tu endpoint verifica la firma y responde `2xx`. Ignora un `X-Lerian-Event-Id` que ya procesó.

Cómo saber que terminó

El ping responde outcome ok, y GET /v1/subscriptions/{id} muestra verification_state active y enabled true.

El ping falla. El ping responde outcome failed con un detail, y la suscripción sigue en pending_verification. Corrige el endpoint y haz el ping de nuevo.
La creación se rechaza. Por defecto, Streaming Hub rechaza un endpoint en una dirección privada, de loopback o de metadatos, o con credenciales en la URL, con 422 endpoint_blocked. Un nombre en uso recibe 409 subscription_name_taken.
El mismo evento llega de nuevo. Solo una respuesta 2xx cuenta como entregada. Streaming Hub hace un reintento para cualquier otra respuesta, así que un evento puede llegar más de una vez.

Resumen

Streaming Hub

Recibir eventos en un webhook

Participantes

Diagrama

Pasos

Cómo saber que terminó

Relacionados

​Participantes

​Diagrama

​Pasos

​Cómo saber que terminó

​Relacionados

Participantes

Diagrama

Pasos

Cómo saber que terminó

Relacionados