Chat request
Using the chat request URL, you can make a POST request that will start a Bridge Workflow on a specified chat channel, using the following request body:
The Inbound Webhook Utility is currently only compatible with JSON payload objects.
{
"channel": "chat chanel name or UUID",
"workflow": "workflow name or UUID",
"stateValues": {
"statename":"value"
},
"runtimeData": {},
"emails": ["one or more user emails"]
}
| Code element | Field type | Description |
|---|---|---|
| channel | Required | Must be set as a valid channel name or UUID |
| workflow | Required | Must be set as a valid workflow name or UUID |
| stateValues | Optional | Preset the workflow states with the specified value |
| runtimeData | Optional | Pass additional data available to the workflow using the {{runtime}} handlebar reference |
| emails | Required | A list of user emails that will be affected by the workflow |
Remember that all requests to this endpoint require the Inbound-Webhook-Secret header to be set with your Secret values.
This solution doesn’t support webhooks, which include a challenge request. This will require a new custom integration to be built.
Chat batch requests
If you want to run more than one workflow with a single request, you can pass a batch object as part of the body request.
{
"channel": "chat chanel name or UUID",
"workflow": "workflow name or UUID",
"stateValues": {
"statename":"value"
},
"runtimeData": {},
"batch": [
{
"emails":["user1@example.com"],
"stateValues": {
"statename":"value1"
}
},
{
"emails":["user2@example.com"],
"stateValues": {
"statename":"value2"
}
}
]
}
If you specify both batch and emails, batch will be used, and emails will be ignored.
Each batch object can specify emails, channel, workflow, stateValues, and runtimeData— the same as the parent object that specified those values. Multiple requests will be made to start the workflows with the different request details.
If you don’t specify channel, workflow, stateValues, or runtimeData in the batch object, then the values from the parent object will be used instead. If you want to override stateValues or runtimeData with no values, send an empty object. Undefined values will be treated as not set. In this case, the parent value will be used.