Workflow Incoming Webhooks
Create an incoming webhook
Changed onCreates an incoming webhook for a workflow. When the webhook URL receives a JSON payload, it creates a workflow run and populates it using the configured mappings.
config.properties maps workflow run properties to JSON paths in the incoming payload:
- Name — run name (string)
- DueDate — due date (ISO 8601 date string)
- Shared — whether the run is shared (boolean)
- Assignees — assignee email addresses (string or array of strings)
- Runner — runner email address (string)
config.formFields maps form field widget IDs to JSON paths for populating form field values on the created run. Keys are widget IDs (Muid), values are JSON path expressions (e.g. $.user.name).
post/workflows/{workflowId}/incoming-webhooks
Request
- Base URLhttps://public-api.process.st/api/v1.1
- URLhttps://public-api.process.st/api/v1.1/workflows/{workflowId}/incoming-webhooks
- Auth
- API key in header X-API-Key
- or HTTP bearer
Path parameters
workflowIdstring required
The ID of the Workflow
Request body
Response
Example response
{
"data": {
"createdBy": {
"id": "paiZa0_oyxEBoZxtatp33g",
"email": "jane.doe@example.com",
"username": "Jane Doe"
},
"updatedBy": {
"id": "paiZa0_oyxEBoZxtatp33g",
"email": "jane.doe@example.com",
"username": "Jane Doe"
},
"workflowId": "mTElZgfw6egBoZxtdIx4_g",
"links": [
{
"href": "https://api.process.st/api/v1.1/resource/XXX"
}
]
},
"links": [
{
"href": "https://api.process.st/api/v1.1/resource/XXX"
}
]
}Changes
- warning
the
request property's maxLength was set to32 - warning
the
request property's maxLength was set to256
- warning