---
title: "Update a webhook subscription"
method: PUT
path: "/webhooks/{subscriptionId}"
tags: ["Manage webhooks"]
---

# Update a webhook subscription

`PUT /webhooks/{subscriptionId}`

Update a webhook subscription

## Path parameters

- `subscriptionId` string, required

## Request body

- UpdateWebhookSubscriptionDTO
  - `events` WebhookEventWriteDTO[] — The webhook events that should remain subscribed
    - `type` 'message_inbound' | 'message_outbound' | 'message_failed' | 'note_created' | 'contact_created' | 'contact_updated' | 'contact_deleted' | 'conversation_opened' | 'conversation_done' | 'conversation_snoozed' | 'conversation_deleted' | 'ai_call_completed'
    - `filters` union[] — The filters to apply to this webhook event subscription
      - union
        - WEBHOOKEVENTFILTERWRITEINBOX
          - `ids` string[] — The inbox identifiers to filter webhook events by
          - `type` 'inbox'
        - WEBHOOKEVENTFILTERWRITECHANNEL
          - `ids` string[] — The channel identifiers to filter webhook events by
          - `type` 'channel'
        - WEBHOOKEVENTFILTERWRITECUSTOMATTRIBUTE
          - `ids` string[] — The custom attribute identifiers to filter webhook events by
          - `type` 'custom_attribute'
        - WEBHOOKEVENTFILTERWRITEDEFAULTATTRIBUTE
          - `attributes` ContactWriteDefaultAttributeField[] — The built-in contact attributes to filter webhook events by
          - `type` 'default_attribute'
        - WEBHOOKEVENTFILTERWRITEHANDLE
          - `handle_types` ContactHandleType[] — The contact handle types to filter webhook events by
          - `type` 'handle'
  - `target_url` string — The updated HTTPS target URL that should receive webhook deliveries

## Response `200`

OK

- WebhookSubscriptionDTO
  - `id` string — The unique identifier of the webhook subscription
  - `target_url` string — The HTTPS target URL that receives webhook deliveries
  - `secret` string, nullable — The secret used to sign webhook deliveries
  - `delivery` WebhookSubscriptionDeliveryDTO
    - `status` 'active' | 'inactive'
    - `reason` 'repeated_delivery_failure' | 'subscription_cancelled', nullable — The reason the webhook subscription became inactive, if any
  - `events` WebhookEventDTO[] — The webhook events configured for this subscription
    - `type` 'message_inbound' | 'message_outbound' | 'message_failed' | 'note_created' | 'contact_created' | 'contact_updated' | 'contact_deleted' | 'conversation_opened' | 'conversation_done' | 'conversation_snoozed' | 'conversation_deleted' | 'ai_call_completed'
    - `filters` union[] — The filters applied to this webhook event subscription
      - union
        - WEBHOOKEVENTFILTERINBOX
          - `ids` InboxPublicId[] — The inbox identifiers this webhook event is filtered by
            - `id` string
          - `type` 'inbox'
        - WEBHOOKEVENTFILTERCHANNEL
          - `ids` MessageChannelConfigPublicId[] — The channel identifiers this webhook event is filtered by
            - `id` string
          - `type` 'channel'
        - WEBHOOKEVENTFILTERCUSTOMATTRIBUTE
          - `ids` ContactAttributePublicId[] — The custom attribute identifiers this webhook event is filtered by
            - `id` string
          - `type` 'custom_attribute'
        - WEBHOOKEVENTFILTERDEFAULTATTRIBUTE
          - `attributes` ContactWriteDefaultAttributeField[] — The built-in contact attributes this webhook event is filtered by
          - `type` 'default_attribute'
        - WEBHOOKEVENTFILTERHANDLE
          - `handle_types` ContactHandleType[] — The contact handle types this webhook event is filtered by
          - `type` 'handle'
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `url` string — The URL of the webhook subscription resource

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.dev/superchat/apis/superchat-api.md) · [All operations](https://skmtc.dev/superchat/apis/superchat-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/superchat/superchat-api/revisions/3bc557a0072f/schema)