Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Workflow Incoming Webhooks

Update an incoming webhook

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.

put/workflows/{workflowId}/incoming-webhooks/{webhookId}

Path parameters

workflowIdstring required

The ID of the Workflow

webhookIdstring required

The ID of the Webhook

Request body

namestring required

Display name.

automationAppstring required
status'Active' | 'Disabled' | 'Deleted' required

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.

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"
    }
  ]
}