# Get 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](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.
Get the webhook subscription with the given ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`
**Scopes:**
`webhooks:read`
# OpenAPI definition
```json
{
"openapi": "3.0.2",
"info": {
"title": "Webhooks API",
"version": "2024-02-15.pre",
"description": "The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.",
"contact": {
"name": "Klaviyo Developer Experience Team",
"email": "developers@klaviyo.com",
"url": "https://developers.klaviyo.com"
},
"termsOfService": "https://www.klaviyo.com/legal/api-terms",
"license": {
"name": "License",
"url": "https://www.klaviyo.com/legal"
}
},
"servers": [
{
"url": "https://a.klaviyo.com",
"description": "Production"
}
],
"paths": {
"/api/webhooks/{id}/": {
"get": {
"operationId": "get_webhook_subscription",
"summary": "Get Webhook Subscription",
"description": "\n > 🚧 This endpoint is in beta and subject to change.\n >\n > 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](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n \n\nGet the webhook subscription with the given ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`webhooks:read`",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the webhook.",
"required": true,
"schema": {
"description": "The ID of the webhook.",
"type": "string"
}
},
{
"name": "fields[webhook]",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2024-02-15.pre/reference/api-overview#sparse-fieldsets",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name",
"description",
"endpoint_url",
"enabled",
"created_at",
"updated_at"
]
}
},
"explode": false
},
{
"name": "include",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2024-02-15.pre/reference/api-overview#relationships",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"webhook-topics"
]
}
},
"explode": false
},
{
"name": "revision",
"in": "header",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"required": true,
"schema": {
"type": "string",
"default": "2024-02-15.pre"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetWebhookResponseCompoundDocument"
}
}
}
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"tags": [
"Subscriptions"
],
"x-klaviyo-pre-release": "BETA",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"webhooks:read"
],
"x-klaviyo-subtag": "Subscriptions"
}
}
},
"components": {
"schemas": {
"WebhookResponseObjectResource": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/WebhookEnum"
},
"id": {
"description": "The ID of the webhook.",
"type": "string",
"example": "01HF7AYTK76RHR4F17G6DGTRGF",
"default": "01HF7AYTK76RHR4F17G6DGTRGF"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"description": "A name for the webhook.",
"type": "string"
},
"description": {
"description": "A description for the webhook.",
"type": "string"
},
"endpoint_url": {
"description": "The url to send webhook requests to, truncated for security.",
"type": "string",
"example": "https://www.example.com",
"default": "https://www.example.com"
},
"enabled": {
"description": "Is the webhook enabled.",
"type": "boolean"
},
"created_at": {
"description": "Date and time when the webhook was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"type": "string",
"format": "date-time",
"example": "2022-11-08T01:23:45+00:00",
"default": "2022-11-08T01:23:45+00:00"
},
"updated_at": {
"description": "Date and time when the webhook was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"type": "string",
"format": "date-time",
"example": "2022-11-08T01:23:45+00:00",
"default": "2022-11-08T01:23:45+00:00"
}
},
"required": [
"name",
"endpoint_url",
"enabled",
"created_at",
"updated_at"
]
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"GetWebhookResponseCompoundDocument": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookResponseObjectResource"
},
{
"properties": {
"relationships": {
"type": "object",
"properties": {
"webhook-topics": {
"type": "object",
"properties": {
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
}
}
}
}
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookTopicResponseObjectResource"
}
}
},
"required": [
"data"
]
},
"WebhookTopicResponseObjectResource": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/WebhookTopicEnum"
},
"id": {
"description": "The ID of the webhook topic.",
"type": "string",
"example": "email:clicked",
"default": "email:clicked"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"links"
]
},
"RelationshipLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
},
"related": {
"type": "string",
"format": "uri"
}
},
"required": [
"self",
"related"
]
},
"ObjectLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"self"
]
},
"WebhookEnum": {
"type": "string",
"enum": [
"webhook"
]
},
"WebhookTopicEnum": {
"type": "string",
"enum": [
"webhook-topic"
]
}
},
"responses": {
"ClientError": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"code",
"title",
"detail"
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"pointer": {
"type": "string"
},
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"errors"
]
}
}
}
},
"ServerError": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"code",
"title",
"detail"
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"pointer": {
"type": "string"
},
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"errors"
]
}
}
}
}
},
"securitySchemes": {
"Klaviyo-API-Key": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "Private key authentication for /api/ endpoints is performed by setting the `Authorization` header to `Klaviyo-API-Key your-private-api-key`
For more information please visit https://developers.klaviyo.com/en/v2024-02-15.pre/reference/api-overview#authentication",
"x-default": "Klaviyo-API-Key your-private-api-key"
}
}
},
"tags": [
{
"name": "Subscriptions"
}
],
"security": [
{
"Klaviyo-API-Key": []
}
],
"x-readme": {
"explorer-enabled": false,
"proxy-enabled": true,
"samples-enabled": true
},
"_id": {
"buffer": {
"0": 102,
"1": 53,
"2": 35,
"3": 137,
"4": 51,
"5": 79,
"6": 56,
"7": 0,
"8": 42,
"9": 5,
"10": 211,
"11": 20
}
}
}
```