Referenz zu eingehenden Webhooks

Workflow-Anforderung

Mit der Webhook-Anforderungs-URL können Sie eine POST-Anforderung erstellen, um einen Smartsheet Bridge-Workflow zu starten. Sie können den folgenden Anforderungstext verwenden:

{

"workflow":"Name oder UUID des Workflows",

"stateValues":{

"statename":"Wert"

        },

"uid":"eine generierte eindeutige ID für die Anfrage",

"extra_stuff":{

"lots":"davon"

    }

}

• workflow: das einzige erforderliche Feld, das als gültiger Workflow-Name oder UUID-Wert festgelegt werden muss
• stateValues: ein optionales Feld, das verwendet wird, um die Workflow-Zustände mit dem angegebenen Wert vorab festzulegen
• uid: Eine eindeutige Kennung (UID), die verwendet wird, damit unser System doppelte Anforderungen ignoriert, wenn Sie dieselbe Anfrage mehrmals senden
• Alle anderen Felder, die Sie als Teil des POST-Textes senden: 
  • Werden an den Workflow übergeben und über die Laufzeit-Handlebars referenziert, z. B. {{runtime.extra_stuff.lots}} mit der entsprechenden Rückgabe
  • Jeder gültige JSON-Wert wird übergeben.

Denken Sie daran, dass für alle Anforderungen an diesen Endpunkt der Inbound-Webhook-Secret-Header mit Ihren Secret-Werten festgelegt werden muss.

Diese Lösung unterstützt keine Webhooks mit Challenge-Anforderung. Dazu muss eine neue benutzerdefinierte Integration erstellt werden.

Workflow-Batch-Anforderungen

Wenn Sie mehr als einen Workflow mit einer einzelnen Anforderung ausführen möchten, können Sie ein Batchobjekt als Teil der Textanforderung übergeben:

{

"workflow":"Name oder UUID des Workflows",

"Stapel":[

        {

"uid": "Anfrage1",

"workflow":"alternativer Workflow",

            "stateValues":{

"state":"Wert"

        },

"runtimeData":{

"key":"Wert"

}

        },

        {

"uid": "Anfrage2",

            "stateValues":{

"state":"Wert"

}

}

]

}

Hinweise

• Das Batch-Anforderungsobjekt verwendet dieselben Felder wie die Hauptanforderung, mit dem Zusatz von runtimeData, das verwendet wird, um die Daten festzulegen, die für die {{runtime}}-Handlebar im Workflow verfügbar sind.

• Wenn Sie im Batch-Anforderungsobjekt keine Workflow- oder Zustandswerte angeben, werden stattdessen die im übergeordneten Objekt festgelegten Werte verwendet. Im obigen Beispiel würden die beiden Workflows request1 mit dem alternativen Workflow und request2 mit dem ursprünglichen Workflow ausführen.
• Wenn Sie die übergeordneten Werte mit einer leeren Eingabe überschreiben möchten, legen Sie ein leeres Objekt für stateValues fest. Nicht definierte Werte werden als nicht festgelegt behandelt und der übergeordnete Wert wird verwendet. Das uid-Feld des übergeordneten Objekts wird ignoriert, wenn Sie Batchanforderungen verwenden, aber jedes Batchobjekt kann bei Bedarf seine eigene UID festlegen.
• Auch wenn jedes Batchobjekt einen eigenen Workflow definiert, ist der Workflow in der Hauptanforderung weiterhin erforderlich.