HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Create Webhook Subscription

🚧

This endpoint is in beta and subject to change.

A beta revision header (2024-02-15.pre) is required to use our Webhooks API. Klaviyo APIs in beta are not intended for use in production. See our versioning and deprecation policy for more information.

Create a new webhook subscription.

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

Scopes:
webhooks:write

Body Params
object
required
string
required
object
required
string
required

A name for the webhook.

string

A description for the webhook.

string
required
Defaults to https://www.example.com/example/path

A url to send webhook calls to. Must be https.

string
required

A secret key, that will be used for webhook request signing.

object
required
object
required
array of objects
required
data*
string
required
string
required
Defaults to email:opened

A list of topics to subscribe to.

Headers
string
required
Defaults to 2024-02-15.pre

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials