Webhooks

Un webhook es una llamada HTTP activada por un evento. Puede utilizar webhooks para activar módulos de activador instantáneos. Cualquier aplicación que esté conectada a Internet y permita peticiones HTTP puede enviar webhooks a Adobe Workfront Fusion.

Requisitos de acceso

Uso de un webhook en Workfront Fusion

Para utilizar un webhook para conectar una aplicación a Workfront Fusion:

Después de crear un webhook, aparece una dirección URL única. Esta es la dirección a la que el webhook envía los datos. Workfront Fusion valida los datos enviados a esta dirección y los transmite para su procesamiento en el escenario.

Configuración de la estructura de datos del webhook configure-the-webhook-s-data-structure

Para reconocer la estructura de datos de la carga útil entrante, Workfront Fusion analiza los datos de ejemplo que envía a la dirección mostrada. Puede proporcionar los datos de muestra realizando un cambio en el servicio o la aplicación que hará que ese servicio o aplicación llame al webhook. Por ejemplo, puede quitar un archivo.

También puede enviar los datos de ejemplo a través del módulo HTTP > Realizar una solicitud:

La cola de ganchos web

Si un webhook recibe datos y no hay un escenario activo que los espere, los datos se almacenan en la cola. Una vez activado el escenario, se procesan secuencialmente todos los paquetes que esperan en la cola.

Formatos de datos entrantes admitidos

Workfront Fusion admite 3 formatos de datos entrantes: Cadena de consulta, Datos de formulario y JSON.

Workfront Fusion valida todos los datos entrantes con respecto a la estructura de datos seleccionada. A continuación, según la configuración del escenario, los datos se almacenan en la cola para su procesamiento o se procesan inmediatamente.

Si alguna parte de los datos no supera la validación, Workfront Fusion devuelve un código de estado HTTP 400 y especifica, en el cuerpo de la respuesta HTTP, el motivo por el que los datos entrantes no superaron las comprobaciones de validación. Si la validación de los datos entrantes se realiza correctamente, Workfront Fusion devuelve el estado "200 Aceptado".

Cadena de consulta

GET https://app.workfrontfusion.com/wh/<yourunique32characterslongstring>?name=<yourname>&job=automate

Datos de formulario

POST https://app.workfrontfusion.com/wh/<yourunique32characterslongstring>

Content-Type: application/x-www-form-urlencoded

name=<yourname>&job=automate

Datos de formulario multiparte

POST https://app.workfrontfusion.com/wh/<yourunique32characterslongstring>


Content-Type: multipart/form-data; boundary=---generatedboundary

---generatedboundary

Content-Disposition: form-data; name="file"; filename="file.txt"


Content-Type: text/plain


Content of file.txt


---generatedboundary

Content-Disposition: form-data; name="name"

Workfront Fusion

---generatedboundary

Para recibir archivos codificados con multipart/form-data, debe configurar una estructura de datos con un campo de tipo collection que contenga los campos anidados name, mime y data. El campo name es un tipo text y contiene el nombre del archivo cargado. mime es un tipo text y contiene un archivo en formato MIME. El campo data es un tipo buffer y contiene datos binarios para el archivo que se está transfiriendo.

Para obtener más información sobre el formato MIME, consulte Módulos MIME.

JSON

POST https://app.workfrontfusion.com/wh/<yourunique32characterslongstring>

Content-Type: application/json

{"name": "Workfront Fusion", "job": "automate"}

Encabezados del webhook

Para acceder a los encabezados del webhook, habilitar encabezados de petición GET al configurar el webhook.

Puede extraer un valor de encabezado determinado con la combinación de las funciones map() y get().

INFO

Ejemplo:

El ejemplo siguiente muestra una fórmula que extrae el valor del encabezado authorization de la matriz Headers[]. La fórmula se utiliza en un filtro que compara el valor extraído con el texto dado para pasar solo webhooks si hay una coincidencia.

Para obtener más información sobre cómo obtener un elemento de una matriz con una clave determinada, vea Asignar un elemento de una matriz con una clave determinada en el artículo Asignar una matriz.

Respuesta a los webhooks

La respuesta predeterminada a una llamada de webhook es el texto “Aceptado”. La respuesta se devuelve a la aplicación que llamó al webhook durante la ejecución del módulo webhook personalizado.

Prueba de la respuesta a un webhook

Si desea personalizar la respuesta del webhook, emplee el módulo Respuesta de webhook.

La configuración del módulo contiene dos campos: Estado y Cuerpo.

El tiempo de espera para enviar una respuesta es de 5 minutos. Si la respuesta no está disponible dentro de ese periodo, Workfront Fusion devuelve el estado “200 Aceptado”.

Ejemplo de respuesta del HTML

INFO

Ejemplo:

Configure el módulo Respuesta del webhook de la siguiente manera:

table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header
Status	Código de estado HTTP de éxito 2xx, p. ej. 200
Body	Código de HTML
Custom headers	> > Clave: Content-type > Valor: text/html >

Esto producirá una respuesta del HTML que se mostrará en un explorador web:

Ejemplo de redireccionamiento

INFO

Ejemplo: configure el módulo Respuesta del webhook de la siguiente manera:

table 0-row-2 1-row-2 layout-auto html-authored no-header
Status	Código de estado HTTP de redirección 3xx, p. ej. 303
Custom headers	> > Key: ubicación > Value: dirección URL a la que desea redirigir. >

Desactivación de un webhook

Los webhooks se desactivan automáticamente si se aplica cualquiera de las siguientes opciones:

Los webhooks desactivados se borran y no se registran automáticamente si no están conectados a ningún escenario y han permanecido en estado desactivado durante más de 30 días.

Resolución de problemas

Elementos que faltan en el panel de asignación

Si faltan algunos elementos en el panel de asignación en la configuración de los módulos siguientes al módulo Webhooks > Webhook personalizado, haga clic en el módulo Webhooks > Webhook personalizado para abrir su configuración y haga clic en Volver a determinar la estructura de datos:

A continuación, siga los pasos descritos en la sección Configurar la estructura de datos del webhook en este artículo.