openapi: 3.1.0
info:
title: Process Street Public Attachments Workflow Incoming Webhooks API
version: '1.1'
description: "The Process Street API is organized around REST. Our API has predictable resource-oriented URLs,\naccepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response\ncodes, authentication, and verbs.\n\nAn [MCP server](https://www.process.st/help/docs/mcp-server/) is also available for integrating with AI agents and tools.\n\n## Core concepts\n\n**Workflow vs Workflow Run.** A **Workflow** (sometimes called a \"playbook\" or template) is the reusable\ndefinition — tasks, form fields, logic, automations. A **Workflow Run** (sometimes called a \"checklist\")\nis one *instance* of running a Workflow. You list available templates via `listWorkflows`; you start one\nvia `createWorkflowRun` (or by scheduling); and you read or update the live state of an in-progress run\nvia the Workflow Runs / Tasks / Form Field Values endpoints. The two are easy to confuse — when in doubt,\n\"Workflow\" is the *blueprint*, \"Workflow Run\" is *one execution*.\n\n**Pages** are similar but standalone: a Page is a content document (no tasks/form fields). A\n**Page Revision** is a versioned snapshot of its content.\n\n## IDs\n\nAll resource IDs are opaque 22-character URL-safe strings (Muids — a base64-encoded UUID). Treat them\nas opaque tokens. Do not parse them, attempt to sort by them, or assume any internal structure. You can\ncompare two IDs for equality with a plain string comparison.\n\n## Dates and times\n\nAll timestamps in requests and responses are ISO-8601, UTC, with millisecond precision\n(e.g. `2024-09-15T14:32:00.000Z`). For date-only fields (typically due dates), use a calendar date\n(`2024-09-15`).\n\n## Pagination\n\nList endpoints page through results using an opaque cursor named `_` (yes, just an underscore).\nThe flow:\n\n1. Call the list endpoint without `_` to get the first page.\n2. Each response includes a `links[]` array. If there are more pages, you'll find an entry with\n `name: \"next\"` whose `href` is a fully-formed URL you can `GET` directly.\n3. Keep following `next.href` until the `next` link is absent — that's the end.\n\nYou can also reuse the `_` value from one response by passing it as the `_` query parameter on the\nnext request, but **following the `href` is simpler and forward-compatible**.\n\n## Authentication\n\nEvery request must include an API key as `X-API-KEY: <your-key>`. Generate keys from your\norganization settings in the Process Street app. Each key carries the permissions of the user that\ncreated it.\n\n## Idempotency and retries\n\n- `GET` requests are safe to retry on any error.\n- `PUT` requests are idempotent — calling them twice with the same body is equivalent to calling once.\n Safe to retry on `5xx`.\n- `DELETE` is idempotent (deleting an already-deleted resource returns `404`, which is fine to ignore).\n- `POST` is generally **not** safe to blindly retry. For workflow runs, attach a `referenceId`\n on create — calling `createWorkflowRun` twice with the same `referenceId` will return the existing\n run instead of creating a duplicate.\n\n## Errors\n\nErrors are returned as a JSON object with this shape:\n\n```json\n{\n \"error\": \"human-readable message\",\n \"errorCode\": \"NotFound\",\n \"requestId\": \"abc123…\",\n \"details\": { \"fieldPath\": \"what went wrong\" }\n}\n```\n\n**When present**, branch on `errorCode` rather than regex'ing `error` (we may rewrite the wording). Include\n`requestId` if you contact support so we can find the request in our logs.\n\n`errorCode` and `requestId` are populated on responses generated by the public API exception handler, which\ncovers the great majority of errors. A few low-level failures (e.g. JSON parse failures caught before the\nhandler runs, framework-level routing errors) may return an `ErrorInfo` without these fields. In that case,\nfall back to the HTTP status code (`400`/`401`/`403`/`404`/`409`/`422`/`429`/`5xx`) — its semantics match\nthe corresponding `errorCode` value.\n\n## Rate limits\n\nAll requests are subject to rate limits. If you receive a `429` response, wait for the duration\nspecified in the `Retry-After` header before retrying.\n"
servers:
- url: https://public-api.process.st/api/v1.1
tags:
- name: Workflow Incoming Webhooks
description: 'An incoming webhook triggers workflow runs from external systems.
Use these endpoints to create, view, update, and delete incoming webhooks for a workflow.'
externalDocs:
url: https://www.process.st/help/docs/run-via-webhook/
description: Process Street help article
paths:
/workflows/{workflowId}/incoming-webhooks:
get:
tags:
- Workflow Incoming Webhooks
summary: List incoming webhooks
description: Returns all non-deleted incoming webhooks for a workflow, including disabled ones.
operationId: listWorkflowIncomingWebhooks
parameters:
- name: workflowId
in: path
description: The ID of the Workflow
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PublicApiIncomingWebhookListResponse'
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
security:
- apiKeyAuth: []
- httpAuth: []
post:
tags:
- Workflow Incoming Webhooks
summary: Create an incoming webhook
description: '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`).'
operationId: createWorkflowIncomingWebhook
parameters:
- name: workflowId
in: path
description: The ID of the Workflow
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWorkflowIncomingWebhookRequest'
examples:
Full config:
summary: Webhook with run properties and form field mappings
value:
name: New Employee Onboarding
automationApp: Zapier
config:
properties:
Name: $.employee.name
DueDate: $.employee.start_date
Assignees: $.employee.manager_email
formFields:
gcWPxsRjNNTeZqaTsBpLhg: $.employee.department
ocsAkBEFkTih7YpuSfJEnw: $.employee.role
Minimal:
summary: Webhook with no mappings — creates a blank workflow run
value:
name: Simple trigger
automationApp: Custom
config: {}
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PublicApiIncomingWebhookResponse'
'400':
description: 'Invalid value for: body'
content:
text/plain:
schema:
type: string
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
security:
- apiKeyAuth: []
- httpAuth: []
/workflows/{workflowId}/incoming-webhooks/{webhookId}:
get:
tags:
- Workflow Incoming Webhooks
summary: Get an incoming webhook
description: Returns an incoming webhook by its ID for a workflow.
operationId: getWorkflowIncomingWebhook
parameters:
- name: workflowId
in: path
description: The ID of the Workflow
required: true
schema:
type: string
- name: webhookId
in: path
description: The ID of the Webhook
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PublicApiIncomingWebhookResponse'
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
security:
- apiKeyAuth: []
- httpAuth: []
put:
tags:
- Workflow Incoming Webhooks
summary: Update an incoming webhook
description: 'Updates an incoming webhook for a workflow. PUT semantics: all fields must be provided. Returns the updated webhook.
See the create endpoint for details on `config.properties` and `config.formFields`.'
operationId: updateWorkflowIncomingWebhook
parameters:
- name: workflowId
in: path
description: The ID of the Workflow
required: true
schema:
type: string
- name: webhookId
in: path
description: The ID of the Webhook
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkflowIncomingWebhookRequest'
examples:
Update with active status:
summary: Update webhook mappings while keeping it active
value:
name: New Employee Onboarding (v2)
automationApp: Zapier
status: Active
config:
properties:
Name: $.employee.full_name
DueDate: $.employee.start_date
Assignees: $.employee.manager_email
formFields:
gcWPxsRjNNTeZqaTsBpLhg: $.employee.department
ocsAkBEFkTih7YpuSfJEnw: $.employee.role
Disable webhook:
summary: Disable a webhook to stop processing incoming payloads
value:
name: Paused webhook
automationApp: Custom
status: Disabled
config: {}
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PublicApiIncomingWebhookResponse'
'400':
description: 'Invalid value for: body'
content:
text/plain:
schema:
type: string
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
security:
- apiKeyAuth: []
- httpAuth: []
delete:
tags:
- Workflow Incoming Webhooks
summary: Delete an incoming webhook
description: Soft-deletes an incoming webhook for a workflow. Subsequent GET requests will return 404.
operationId: deleteWorkflowIncomingWebhook
parameters:
- name: workflowId
in: path
description: The ID of the Workflow
required: true
schema:
type: string
- name: webhookId
in: path
description: The ID of the Webhook
required: true
schema:
type: string
responses:
'204':
description: ''
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
security:
- apiKeyAuth: []
- httpAuth: []
components:
schemas:
UpdateWorkflowIncomingWebhookRequest:
title: UpdateWorkflowIncomingWebhookRequest
type: object
required:
- name
- automationApp
- status
- config
properties:
name:
description: Display name.
type: string
automationApp:
type: string
status:
description: 'Incoming webhook lifecycle.
- `Active` — the webhook accepts and processes incoming payloads.
- `Disabled` — the URL still resolves but payloads are dropped without triggering a run.
- `Deleted` — the webhook is soft-deleted; only returned by endpoints that explicitly include deleted records.
'
type: string
enum:
- Active
- Disabled
- Deleted
config:
title: CreateWorkflowIncomingWebhookConfigRequest
description: Field-specific configuration. Shape depends on `fieldType`.
type: object
properties:
properties:
description: Mapping from workflow-run property names (e.g. `Name`, `DueDate`, `Assignees`) to JSONPath expressions in the incoming payload.
type: object
additionalProperties:
type: string
formFields:
description: Mapping from form-field IDs to JSONPath expressions in the incoming payload.
type: object
additionalProperties:
type: string
PublicApiIncomingWebhookResponse:
title: PublicApiIncomingWebhookResponse
type: object
required:
- data
properties:
data:
title: PublicApiIncomingWebhook
type: object
required:
- id
- createdDate
- createdBy
- updatedDate
- updatedBy
- workflowId
- name
- automationApp
- status
- url
- config
properties:
id:
title: EntityID
description: The resource's ID.
type: string
createdDate:
description: When the resource was first created. ISO-8601 UTC.
type: string
format: date-time
createdBy:
description: User who created the resource.
examples:
- id: iAaSNCU5lWLYGAi663hO8Q
email: jane.doe@example.com
username: Jane Doe
type: object
required:
- id
- email
- username
properties:
id:
title: EntityID
description: The resource's ID.
type: string
email:
description: The user's email address (also their login identifier).
type: string
username:
description: The user's display name (e.g. `Jane Doe`).
type: string
updatedDate:
description: When the resource was last modified. ISO-8601 UTC.
type: string
format: date-time
updatedBy:
description: User who last modified the resource.
examples:
- id: iAaSNCU5lWLYGAi663hO8Q
email: jane.doe@example.com
username: Jane Doe
type: object
required:
- id
- email
- username
properties:
id:
title: EntityID
description: The resource's ID.
type: string
email:
description: The user's email address (also their login identifier).
type: string
username:
description: The user's display name (e.g. `Jane Doe`).
type: string
workflowId:
description: The ID of the Workflow
examples:
- ucBWWop27GXEGmStvtRH_Q
type: string
name:
description: Human-readable label for the webhook (e.g. "Salesforce → Onboarding").
type: string
automationApp:
description: Label of the automation app or integration source (e.g. `Zapier`, `Custom`, `Salesforce`).
type: string
status:
description: Whether the incoming webhook is currently accepting payloads. `Active` — incoming requests at the webhook URL create or update a workflow run. `Disabled` — the webhook URL is configured but requests are ignored.
type: string
enum:
- Active
- Disabled
url:
description: Public URL to POST payloads to. Include this in the upstream system's webhook config.
type: string
config:
title: PublicApiIncomingWebhookConfig
description: Field-specific configuration. Shape depends on `fieldType`.
type: object
required:
- properties
- formFields
properties:
properties:
description: Mapping from workflow-run property names (e.g. `Name`, `DueDate`, `Assignees`) to JSONPath expressions in the incoming payload.
type: object
additionalProperties:
type: string
formFields:
description: Mapping from form-field IDs to JSONPath expressions in the incoming payload.
type: object
additionalProperties:
type: string
links:
description: Navigable HATEOAS links to related resources. Each entry has a `name` (RFC-5988 link relation like `self`, `edit`, `related`), an `href` URL, and a `type` (`Api` for callable endpoints, `App` for browser-facing URLs). Prefer following these `href` values over constructing URLs by hand.
type: array
items:
title: Link
description: A HATEOAS link to a related resource. Use these to navigate between resources without constructing URLs by hand.
type: object
required:
- name
- href
- type
properties:
name:
description: Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
type: string
href:
title: Uri
description: URL of the linked resource.
examples:
- https://api.process.st/api/v1.1/resource/XXX
type: string
rel:
description: Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
type: string
enum:
- Approval Task
- Approvals
- Assignees
- Comment
- Data Set Records
- Data Sets
- Form Field Values
- Subject Task
- Task
- Tasks
- Users
- Webhook
- Workflow
- Workflow Run
type:
description: Whether this link targets an API endpoint or a Process Street app URL. `Api` — a callable API endpoint you can fetch directly. `App` — a browser-facing URL in the Process Street UI.
type: string
enum:
- Api
- App
links:
description: 'Pagination links. When the result has more pages, look for an entry with `name: "next"` — its `href` is the URL to fetch the next page. Absence of `next` means there are no more pages. For single-resource responses this array is typically empty.'
type: array
items:
title: Link
description: A HATEOAS link to a related resource. Use these to navigate between resources without constructing URLs by hand.
type: object
required:
- name
- href
- type
properties:
name:
description: Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
type: string
href:
title: Uri
description: URL of the linked resource.
examples:
- https://api.process.st/api/v1.1/resource/XXX
type: string
rel:
description: Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
type: string
enum:
- Approval Task
- Approvals
- Assignees
- Comment
- Data Set Records
- Data Sets
- Form Field Values
- Subject Task
- Task
- Tasks
- Users
- Webhook
- Workflow
- Workflow Run
type:
description: Whether this link targets an API endpoint or a Process Street app URL. `Api` — a callable API endpoint you can fetch directly. `App` — a browser-facing URL in the Process Street UI.
type: string
enum:
- Api
- App
PublicApiIncomingWebhookListResponse:
title: PublicApiIncomingWebhookListResponse
type: object
properties:
data:
description: The list of resources returned by this request.
type: array
items:
title: PublicApiIncomingWebhook
type: object
required:
- id
- createdDate
- createdBy
- updatedDate
- updatedBy
- workflowId
- name
- automationApp
- status
- url
- config
properties:
id:
title: EntityID
description: The resource's ID.
type: string
createdDate:
description: When the resource was first created. ISO-8601 UTC.
type: string
format: date-time
createdBy:
description: User who created the resource.
examples:
- id: iAaSNCU5lWLYGAi663hO8Q
email: jane.doe@example.com
username: Jane Doe
type: object
required:
- id
- email
- username
properties:
id:
title: EntityID
description: The resource's ID.
type: string
email:
description: The user's email address (also their login identifier).
type: string
username:
description: The user's display name (e.g. `Jane Doe`).
type: string
updatedDate:
description: When the resource was last modified. ISO-8601 UTC.
type: string
format: date-time
updatedBy:
description: User who last modified the resource.
examples:
- id: iAaSNCU5lWLYGAi663hO8Q
email: jane.doe@example.com
username: Jane Doe
type: object
required:
- id
- email
- username
properties:
id:
title: EntityID
description: The resource's ID.
type: string
email:
description: The user's email address (also their login identifier).
type: string
username:
description: The user's display name (e.g. `Jane Doe`).
type: string
workflowId:
description: The ID of the Workflow
examples:
- ucBWWop27GXEGmStvtRH_Q
type: string
name:
description: Human-readable label for the webhook (e.g. "Salesforce → Onboarding").
type: string
automationApp:
description: Label of the automation app or integration source (e.g. `Zapier`, `Custom`, `Salesforce`).
type: string
status:
description: Whether the incoming webhook is currently accepting payloads. `Active` — incoming requests at the webhook URL create or update a workflow run. `Disabled` — the webhook URL is configured but requests are ignored.
type: string
enum:
- Active
- Disabled
url:
description: Public URL to POST payloads to. Include this in the upstream system's webhook config.
type: string
config:
title: PublicApiIncomingWebhookConfig
description: Field-specific configuration. Shape depends on `fieldType`.
type: object
required:
- properties
- formFields
properties:
properties:
description: Mapping from workflow-run property names (e.g. `Name`, `DueDate`, `Assignees`) to JSONPath expressions in the incoming payload.
type: object
additionalProperties:
type: string
formFields:
description: Mapping from form-field IDs to JSONPath expressions in the incoming payload.
type: object
additionalProperties:
type: string
links:
description: Navigable HATEOAS links to related resources. Each entry has a `name` (RFC-5988 link relation like `self`, `edit`, `related`), an `href` URL, and a `type` (`Api` for callable endpoints, `App` for browser-facing URLs). Prefer following these `href` values over constructing URLs by hand.
type: array
items:
title: Link
description: A HATEOAS link to a related resource. Use these to navigate between resources without constructing URLs by hand.
type: object
required:
- name
- href
- type
properties:
name:
description: Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
type: string
href:
title: Uri
description: URL of the linked resource.
examples:
- https://api.process.st/api/v1.1/resource/XXX
type: string
rel:
description: Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
type: string
enum:
- Approval Task
- Approvals
- Assignees
- Comment
- Data Set Records
- Data Sets
- Form Field Values
- Subject Task
- Task
- Tasks
- Users
- Webhook
- Workflow
- Workflow Run
type:
description: Whether this link targets an API endpoint or a Process Street app URL. `Api` — a callable API endpoint you can fetch directly. `App` — a browser-facing URL in the Process Street UI.
type: string
enum:
- Api
- App
links:
description: 'Pagination links. When the result has more pages, look for an entry with `name: "next"` — its `href` is the URL to fetch the next page. Absence of `next` means there are no more pages. For single-resource responses this array is typically empty.'
type: array
items:
title: Link
description: A HATEOAS link to a related resource. Use these to navigate between resources without constructing URLs by hand.
type: object
required:
- name
- href
- type
properties:
name:
description: Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
type: string
href:
title: Uri
description: URL of the linked resource.
examples:
- https://api.process.st/api/v1.1/resource/XXX
type: string
rel:
description: Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
type: string
enum:
- Approval Task
- Approvals
- Assignees
- Comment
- Data Set Records
- Data Sets
- Form Field Values
- Subject Task
- Task
- Tasks
- Users
- Webhook
- Workflow
- Workflow Run
type:
description: Whether this link targets an API endpoint or a Process Street app URL. `Api` — a callable API endpoint you can fetch directly. `App` — a browser-facing URL in the Process Street UI.
type: string
enum:
- Api
- App
CreateWorkflowIncomingWebhookRequest:
title: CreateWorkflowIncomingWebhookRequest
type: object
required:
- name
- automationApp
- config
properties:
name:
description: Display name.
type: string
automationApp:
type: string
config:
title: CreateWorkflowIncomingWebhookConfigRequest
description: Field-specific configuration. Shape depends on `fieldType`.
type: object
properties:
properties:
description: Mapping from workflow-run property names (e.g. `Name`, `DueDate`, `Assignees`) to JSONPath expressions in the incoming payload.
type: object
additionalProperties:
type: string
formFields:
description: Mapping from form-field IDs to JSONPath expressions in the incoming payload.
type: object
additionalProperties:
type: string
ErrorInfo:
title: ErrorInfo
type: object
required:
- error
properties:
error:
description: 'Human-readable error message. Suitable for logs or for surfacing to end users; do not pars
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/process-street/refs/heads/main/openapi/process-street-workflow-incoming-webhooks-api-openapi.yml