PRprocess
Webhooks

Update a webhook

Updates a webhook subscription. PUT semantics: all fields must be provided. Returns the updated webhook.

put/webhooks/{webhookId}

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/webhooks/{webhookId}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

webhookIdstring required

The ID of the Webhook

Request body

urlstring required

Target URL.

triggersstring[]
workflowIdstring

The ID of the Workflow.

taskIdstring

The ID of the Task.

Response

Example response

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

Changes

No recorded changes to this operation across all 16 revisions of this API.