Applica a
Riferimento ai webhook in ingresso
Chi può usarlo?
Piani:
- Bridge by Smartsheet
Richiesta di flusso di lavoro
Con l’URL di richiesta webhook, puoi effettuare una richiesta POST per avviare un flusso di lavoro Bridge. Puoi utilizzare il seguente corpo della richiesta:
{
"workflow":"nome flusso di lavoro o UUID",
"stateValues":{
"statename":"valore"
},
"uid":"un ID univoco generato per la richiesta",
"extra_stuff":{
"lotti":"di esso"
}
}
- workflow (flusso di lavoro): l’unico campo obbligatorio, deve essere impostato come un nome di flusso di lavoro valido o un valore UUID.
- stateValues: campo facoltativo utilizzato per preimpostare gli stati del flusso di lavoro con il valore specificato.
- uid: un identificatore univoco (uid) utilizzato in modo che il nostro sistema ignori le richieste duplicate se invii la stessa richiesta più volte
- Ogni altro campo inviato come parte del corpo del POST:
- Passato al flusso di lavoro, viene citato utilizzando handlebar di runtime, ad esempio {{runtime.extra_stuff.lots}}, con ritorno
- Verrà passato qualsiasi valore JSON valido
Tieni presente che tutte le richieste a questo endpoint richiedono l’impostazione dell’intestazione Inbound-Webhook-Secret con i valori Secret.
Questa soluzione non supporta i webhook, che includono una richiesta di verifica. Ciò richiede la creazione di una nuova integrazione personalizzata.
Richieste in batch di flussi di lavoro
Se desideri eseguire più di un flusso di lavoro con una singola richiesta, puoi passare un oggetto batch come parte del corpo della richiesta:
{
"workflow":"nome flusso di lavoro o UUID",
"batch":[
{
"uid": "request1",
"flusso di lavoro":"flusso di lavoro alternativo",
"stateValues":{
"state":"valore"
},
"runtimeData":{
Key/Value
}
},
{
"uid": "richiesta2",
"stateValues":{
"state":"valore"
}
}
]
}
Note
L’oggetto della richiesta in batch utilizza gli stessi campi della richiesta principale, con l’aggiunta di runtimeData, che viene utilizzato per impostare i dati disponibili per l’handlebar {{runtime}} nel flusso di lavoro.
- Se non si specificano valori di flusso di lavoro o di stato nell’oggetto della richiesta in batch, vengono utilizzati i valori impostati nell’oggetto madre. Nell’esempio precedente, i due flussi di lavoro eseguirebbero request1 con il flusso di lavoro alternativo e request2 con il flusso di lavoro iniziale.
- Se desideri eseguire l’override dei valori madre senza nulla, imposta un oggetto vuoto per stateValues. I valori non definiti vengono considerati come non impostati e verrà utilizzato il valore madre. Il campo uid dell’oggetto madre viene ignorato quando si utilizzano richieste in batch, ma ogni oggetto batch può impostare il proprio uid, se necessario.
- Anche se ogni oggetto in batch definisce il proprio flusso di lavoro, il flusso di lavoro nella richiesta principale è comunque necessario.