Los webhooks notifican a servicios externos, como clientes de chat u otras API externas, sobre eventos. Un webhook puede establecer una URL cuando ocurre un evento específico.
Phrase Orchestrator proporciona un servicio que supervisa y procesa notificaciones de sistemas de terceros. Este servicio permite a los usuarios conectar sus flujos de trabajo con una amplia variedad de sistemas externos que admiten solicitudes HTTP.
Los usuarios pueden crear una nueva activación para webhooks entrantes a partir de eventos externos con el sistema generando automáticamente una URL de webhook única con clave API para configurar el webhook de terceros. La URL del webhook generada es única y está directamente asociada con la cuenta del usuario y el flujo de trabajo, lo que significa que cada webhook solo está vinculado a un flujo de trabajo.
Configurar webhook entrante
Para realizar la configuración de un webhook entrante, siga estos pasos:
-
Arrastra y suelta una activación en un flujo de trabajo.
La activación aparece en el flujo de trabajo.
-
Haz clic en la activación para abrir la pestaña .
-
Selecciona la pestaña .
-
Copiar la .
Esta URL debe considerarse secreta y no debe compartirse. Si se comparte accidentalmente, haz clic en Regenerate para crear uno nuevo e invalidar el existente.
-
Para enviar una carga útil con datos para usar dentro de los flujos de trabajo, proporcione el esquema de esa carga útil.
-
Para proporcionar un esquema, haz clic en Edit webhook.
-
Selecciona un :
Los esquemas JSON son un estándar para definir cargas útiles JSON. Si un servicio existente que los usa, o un servicio externo para conectarse a Orchestrator proporciona uno, cópielo tal cual.
-
JSON
Proporcione una carga útil JSON de muestra para una configuración más sencilla, lo que permite probar el webhook sin definir reglas exactas.
-
JSON Schema
Defina con precisión la estructura, los tipos de datos y las reglas de validación para los datos JSON.
-
-
Haz clic en Save payload schema.
Se muestra una vista previa de la estructura de datos esperada para la activación del webhook.
-
-
Si es necesario, abre la pestaña para agregar filtros a la activación.
-
Para activar un flujo de trabajo una vez que se haya publicado, envíe una solicitud POST a la URL del webhook. Para los flujos de trabajo que no tienen un esquema de configuración, el cuerpo debe estar vacío. Si se aplica un esquema de configuración, la carga útil debe tener concordancia con el esquema.
Los usuarios pueden realizar la configuración de flujos de trabajo que no solo reciben datos, sino que también envían actualizaciones a sistemas externos automáticamente. La acción de webhook saliente permite a los usuarios activar automáticamente acciones específicas en sistemas externos.
Los webhook en otros servicios pueden activarse a través de la acción Enviar solicitud HTTP.
Configurar un webhook saliente
Para configurar un webhook saliente, siga estos pasos: