HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Update 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.

Update the webhook subscription with the given ID.

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

Scopes:
webhooks:write

Path Params
string
required

The ID of the webhook.

Body Params
object
required
string
required
string
required

The ID of the webhook.

object
required
string

A name for the webhook.

string

A description for the webhook.

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

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

string

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

boolean

Is the webhook enabled.

object
object
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