---
title: "Update a webhook"
method: PUT
path: "/webhooks/{webhookId}"
tags: ["Webhooks"]
---

# Update a webhook

`PUT /webhooks/{webhookId}`

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

## Path parameters

- `webhookId` string, required

## Request body

- UpdateWebhookRequest
  - `url` string, required — Target URL.
  - `triggers` string[]
  - `workflowId` string — The ID of the Workflow.
  - `taskId` string — The ID of the Task.

## Response `200`

- PublicApiWebhookResponse
  - `data` object, required
    - `id` string, required — The ID of the Webhook
    - `createdDate` string, date-time, required — When the resource was first created. ISO-8601 UTC.
    - `createdBy` object, required — User who created the resource.
      - `id` string, required — The resource's ID.
      - `email` string, required — The user's email address (also their login identifier).
      - `username` string, required — The user's display name (e.g. `Jane Doe`).
    - `updatedDate` string, date-time, required — When the resource was last modified. ISO-8601 UTC.
    - `updatedBy` object, required — User who last modified the resource.
      - `id` string, required — The resource's ID.
      - `email` string, required — The user's email address (also their login identifier).
      - `username` string, required — The user's display name (e.g. `Jane Doe`).
    - `url` string, required — HTTPS endpoint to which event payloads are POSTed.
    - `triggers` string[] — Trigger event names this webhook fires on. Typical values include `WorkflowRunCreated`, `WorkflowRunCompleted`, `TaskChecked`, `TaskUnchecked`, `TaskCheckedUnchecked`, and `TaskReady`. Webhooks created via internal tooling may surface additional trigger names.
    - `status` 'Active' | 'Disabled', required — Whether the webhook is currently delivering events. `Active` — events that match the configured triggers are delivered to the webhook URL. `Disabled` — the webhook is configured but no events are delivered.
    - `workflowId` string — The ID of the Workflow.
    - `taskId` string — The ID of the Task.
    - `links` object[] — 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.
      - `name` string, required — Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
      - `href` string, required — URL of the linked resource.
      - `rel` 'Approval Task' | 'Approvals' | 'Assignees' | 'Comment' | 'Data Set Records' | 'Data Sets' | 'Form Field Values' | 'Subject Task' | 'Task' | 'Tasks' | 'Users' | 'Webhook' | 'Workflow' | 'Workflow Run' — Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
      - `type` 'Api' | 'App', required — 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.
  - `links` object[] — 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.
    - `name` string, required — Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
    - `href` string, required — URL of the linked resource.
    - `rel` 'Approval Task' | 'Approvals' | 'Assignees' | 'Comment' | 'Data Set Records' | 'Data Sets' | 'Form Field Values' | 'Subject Task' | 'Task' | 'Tasks' | 'Users' | 'Webhook' | 'Workflow' | 'Workflow Run' — Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
    - `type` 'Api' | 'App', required — 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.

## Other responses

- `400` — Invalid value for: body
- `default`

---

[API](https://skmtc.net/process/apis/process-street-public-api.md) · [All operations](https://skmtc.net/process/apis/process-street-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/process/process-street-public-api/revisions/6199a9464227/schema)