Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Workflow Incoming Webhooks

Create an incoming webhook

Creates 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

Path parameters

workflowIdstring required

The ID of the Workflow

Request body

namestring required

Display name.

automationAppstring required

Response

Example response

{
  "data": {
    "createdBy": {
      "id": "naAJxoDIuwdgNsQHGRRGqA",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "naAJxoDIuwdgNsQHGRRGqA",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "workflowId": "l0sYejKfFXVwcykbTr9Cew",
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}