Create Webhook

post https://a.klaviyo.com/api/webhooks

Create a new Webhook

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

Scopes:
webhooks:write

Responses

Language

Credentials

Header


xxxxxxxxxx
13
1
curl --request POST \
2
     --url https://a.klaviyo.com/api/webhooks \
3
     --header 'Authorization: Klaviyo-API-Key your-private-api-key' \
4
     --header 'accept: application/vnd.api+json' \
5
     --header 'content-type: application/vnd.api+json' \
6
     --header 'revision: 2024-10-15' \
7
     --data '
8
{
9
  "data": {
10
    "type": "webhook"
11
  }
12
}
13
'


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
      }

201Success

4XXClient Error

5XXServer Error