Update Webhook Subscription

patch https://a.klaviyo.com/api/webhooks/{id}/

🚧
This endpoint is in beta and subject to change.
A beta revision header (2024-05-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our versioning and deprecation policy for more information.

Update the webhook subscription with the given ID.

Rate limits:
Burst: 1/s
Steady: 15/m

Scopes:
webhooks:write

Responses

Language

Credentials

Header


xxxxxxxxxx
16
1
curl --request PATCH \
2
     --url https://a.klaviyo.com/api/webhooks/id/ \
3
     --header 'Authorization: Klaviyo-API-Key your-private-api-key' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --header 'revision: 2024-05-15.pre' \
7
     --data '
8
{
9
  "data": {
10
    "type": "webhook",
11
    "attributes": {
12
      "endpoint_url": "https://www.example.com/example/path"
13
    }
14
  }
15
}
16
'


xxxxxxxxxx
31
}
1
{
2
  "data": {
3
    "type": "webhook",
4
    "id": "01HF7AYTK76RHR4F17G6DGTRGF",
5
    "attributes": {
6
      "name": "My Webhook",
7
      "description": "A webhook for sms events",
8
      "endpoint_url": "https://www.example.com",
9
      "enabled": true,
10
      "created_at": "2022-11-08T01:23:45+00:00",
11
      "updated_at": "2022-11-08T01:23:45+00:00"
12
    },
13
    "relationships": {
14
      "webhook-topics": {
15
        "data": [
16
          {
17
            "type": "webhook-topic",
18
            "id": "event:klaviyo.sent_sms"
19
          }
20
        ],
21
        "links": {
22
          "self": "string",
23
          "related": "string"
24
        }
25
      }

200Success

4XXClient Error

5XXServer Error