---
title: "Update a webhook subscription"
method: PUT
path: "/webhook_subscriptions/{id}"
tags: ["Webhooks"]
---

# Update a webhook subscription

`PUT /webhook_subscriptions/{id}`

Updates an existing webhook subscription.

Only the fields being updated need to be included on the request.  This operation does not
support updating the `delivery_method` of the webhook subscription.

Scoped OAuth requires: `webhook_subscriptions.write`

## Path parameters

- `id` string, required

## Headers

- `Accept` string, required
- `Content-Type` 'application/json', required

## Request body

- WebhookSubscriptionUpdate
  - `webhook_subscription` object
    - `description` string — A short description of the webhook subscription.
    - `events` string[] — The set of outbound event types the subscription will receive.
    - `filter` object
      - `id` string — The id of the object being used as the filter. This field is required for all filter types except account_reference.
      - `type` 'account_reference' | 'service_reference' | 'team_reference' — The type of object being used as the filter.
    - `active` boolean — If true, a webhook will be sent. True is the default state. If false, a webhook will not be sent.
    - `oauth_client_id` string, nullable — The ID of the OAuth client to use for authenticating webhook requests. Optional field.

## Response `200`

The updated webhook subscription.

- object
  - `webhook_subscription` WebhookSubscription, required
    - `id` string
    - `type` 'webhook_subscription', required — The type indicating the schema of the object.
    - `active` boolean — Determines whether this subscription will produce webhook events.
    - `delivery_method` object, required
      - `id` string
      - `secret` string, nullable — The secret used to sign webhook payloads. Only provided on the initial create response.
      - `temporarily_disabled` boolean — Whether or not this webhook subscription is temporarily disabled. Becomes `true` if the delivery method URL is repeatedly rejected by the server.
      - `type` 'http_delivery_method', required — Indicates the type of the delivery method.
      - `url` string, url, required — The destination URL for webhook delivery.
      - `custom_headers` object[] — Optional headers to be set on this webhook subscription when sent. The header values are redacted in GET requests, but are not redacted on the webhook when delivered to the webhook's endpoint.
        - `name` string — The header name
        - `value` string — The header value
    - `description` string — A short description of the webhook subscription.
    - `events` string[], required — The set of outbound event types the webhook will receive.
    - `filter` object, required
      - `id` string — The id of the object being used as the filter. This field is required for all filter types except account_reference.
      - `type` 'account_reference' | 'service_reference' | 'team_reference', required — The type of object being used as the filter.
    - `oauth_client` object — OAuth client details. This field is populated in responses when oauth_client_id is set.
      - `id` string, required — The ID of the OAuth client
      - `type` 'oauth_client_reference', required — The type of object being referenced
      - `summary` string — A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client

## Other responses

- `400` — Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work.
- `401` — Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed.
- `403` — Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action.
- `404` — The requested resource was not found.

---

[API](https://skmtc.net/pagerduty/apis/rest-api.md) · [All operations](https://skmtc.net/pagerduty/apis/rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pagerduty/rest-api/versions/b679a8f3f02c/schema)