---
title: "Patch Webhook Subscription"
method: PATCH
path: "/beta/webhooks/{webhookSubscriptionId}"
tags: ["Webhooks"]
---

# Patch Webhook Subscription

`PATCH /beta/webhooks/{webhookSubscriptionId}`

Patch a Webhook Subscription.

## Path parameters

- `webhookSubscriptionId` string, uuid, required

## Request body

- PatchWebhookSubscriptionInput
  - `name` string — The Webhook Subscription name
  - `events` string[] — The set of events this Webhook Subscription subscribes to. Allowed values: [SLAEvaluationVoided, ConversationPending, SLAEvaluationBreached, ConversationMessageAdded, ConversationCustomAttributeUpdated, SLAEvaluationAchieved, ConversationAssigned, ConversationMessageDeliveryDelivered, ConversationMessageDeliveryInfo, ConversationTransferred, ConversationEnqueued, AgentUnbannedEnduser, TypingStarted, ConversationCreated, ConversationUnassigned, ConversationOpen, ConversationAbandoned, ConversationClosed, ConversationMessageDeliveryFailed, ConversationTagAdded, ConversationNoteAdded, AgentBannedEnduser, ConversationEndUserReplaced, ConversationMessageDeliverySeen, AgentUnbannedIp, ConversationMessageDeliverySent, AgentBannedIp, ConversationTagRemoved, ConversationRated, SLAEvaluationPending, ConversationMessageDeliverySpamComplaint, ConversationPendingExpired]
  - `url` string — URL of the server that the webhook request should be sent to
  - `authorization` union — Authorization to be added as a header in the webhook request. Can be either, Basic auth, added as 'Basic base64encoded(\<username\>:\<password\>)', Token auth, added as 'Bearer \<token value\>', or no auth
    - BasicAuth
      - `username` string, required
      - `password` string, required
    - NoAuth
    - TokenAuth
      - `value` string, required — Token value. It will be added in the headers of the request as: 'Authorization': 'Bearer \<value\>'
  - `customHeaders` MapString
  - `enabled` boolean — Defines whether this Webhook Subscription is enabled or disabled
  - `filters` MapWebhookEventTypeFilters

## Response `200`

The patched Webhook Subscription

- PatchWebhookSubscriptionOutput
  - `data` WebhookSubscription, required
    - `id` string, uuid, required — The Webhook Subscription ID
    - `name` string, required — The Webhook Subscription name
    - `subscribedEvents` string[] — The set of events this Webhook Subscription is subscribed to
    - `url` string, required — URL of the server that the webhook request should be sent to
    - `headers` WebhookHeadersMapStringString, required — The headers that will be added to the webhook request
    - `secretKey` string, required — Dixa generated secret key, used to sign the requests
    - `enabled` boolean, required — Defines whether this Webhook Subscription is enabled or disabled
    - `createdAt` string, date-time, required — Date when this Webhook Subscription was created
    - `createdBy` string, uuid, required — The ID of the user who created this Webhook Subscription
    - `updatedAt` string, date-time, required — Date when this Webhook Subscription was last updated
    - `updatedBy` string, uuid, required — The ID of the user who last updated this Webhook Subscription
    - `filters` MapWebhookEventTypeFilters

## Other responses

- `400` — Invalid value for: path parameter webhookSubscriptionId, Invalid value extracted from request context, Invalid value for: body, Validation failure during Webhook Subscription patching
- `500` — Internal Server Error

---

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