Aplica a
Referencia de webhooks entrantes
Who can use this?
Plans:
- Bridge by Smartsheet
Solicitud de flujo de trabajo
Con la URL de solicitud de webhook, puede hacer un solicitud POST (PUBLICAR) para iniciar un flujo de trabajo de Bridge. Puede utilizar el siguiente texto de solicitud:
{
"flujo de trabajo":"nombre del flujo de trabajo o UUID",
"stateValues":{
"nombre de estado":"valor"
},
"uid":"un ID único generado para la solicitud",
"extra_stuff":{
"montones": "de ello"
}
}
- workflow (flujo de trabajo): El único campo obligatorio; debe definirse como un nombre de flujo de trabajo o un valor UUID válidos.
- stateValues: Campo opcional que se utiliza para preestablecer los estados del flujo de trabajo con el valor especificado.
- uid: Un identificador único (uid) utilizado para que el sistema omita las solicitudes duplicadas si envía la misma solicitud varias veces
- Los demás campos que envía como parte del texto de POST (PUBLICAR):
- Se envían al flujo de trabajo y se hacen referencia a ellos mediante el uso de handlebars de tiempo de ejecución, por ejemplo {{runtime.extra_stuff.lots}}, con el resultado
- Se enviará cualquier valor JSON válido
Recuerde que todas las solicitudes a este extremo requieren que se establezca el encabezado Inbound-Webhook-Secret con sus valores Secret.
Esta solución no admite webhooks, que incluyen una solicitud de desafío. Para ello se debe crear una nueva integración personalizada.
Solicitudes de flujo de trabajo por lotes
Si desea ejecutar más de un flujo de trabajo con una sola solicitud, puede enviar un objeto por lotes como parte del texto de la solicitud:
{
"flujo de trabajo":"nombre del flujo de trabajo o UUID",
"por lotes":[
{
"uid": "solicitud1",
"flujo de trabajo": "flujo de trabajo alternativo",
"stateValues":{
"estado": "valor"
},
"datos en tiempo de ejecución":{
"clave": "valor"
}
},
{
"uid": "request2",
"stateValues":{
"estado": "valor"
}
}
]
}
Notas
El objeto de la solicitud por lotes utiliza los mismos campos que la solicitud principal, con la incorporación de runtimeData, que se utiliza para definir los datos disponibles para el handlebar {{runtime}} en el flujo de trabajo.
- Si no especifica un flujo de trabajo o valores de estado en su objeto de solicitud por lotes, se utilizan en su lugar los valores establecidos en el objeto primario. En el ejemplo anterior, se ejecutarían los dos flujos de trabajo request1 con el flujo de trabajo alternativo, y request2 con el flujo de trabajo inicial.
- Si desea anular los valores primarios con nada, defina un objeto vacío para stateValues. Los valores indefinidos se tratan como no establecidos y se utilizará el valor primario. El campo uid del objeto primario se ignora cuando se utilizan solicitudes por lotes, pero cada objeto por lotes puede establecer su propio uid si es necesario.
- Incluso si cada objeto de lote define su propio flujo de trabajo, el flujo de trabajo de la solicitud primaria sigue siendo obligatorio.