API ReferenceWebhooks

Get Subscription

Retrieve a specific webhook subscription with its recent delivery attempts.

Returns the subscription configuration along with a history of message delivery attempts. This is useful for debugging delivery issues or verifying that your endpoint is correctly receiving events.

Use include_secret=true to also retrieve the signing secret for webhook signature verification. Keep this secret secure.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

subscription_idstringRequired

The unique identifier of the subscription to retrieve (UUID).

Query parameters

include_secretbooleanOptionalDefaults to false

Include the signing secret for webhook signature verification. Keep this secret secure and use it to verify the ‘svix-signature’ header.

Response

Subscription with delivery attempts
idstring

Unique identifier for this subscription (UUID format)

urlstring
The URL where webhook events are delivered
created_atstringformat: "date-time"

When this subscription was created (ISO 8601 format, UTC)

updated_atstringformat: "date-time"

When this subscription was last updated (ISO 8601 format, UTC)

filter_typeslist of strings or null
Event types this subscription is filtered to receive. See EventType enum for all available types.
disabledboolean or nullDefaults to false
Whether this subscription is currently disabled. Disabled subscriptions do not receive event deliveries.
descriptionstring or null

Optional human-readable description of this subscription

health_statusenum or null

Health status of this subscription based on recent delivery attempts. Values: ‘healthy’ (all recent deliveries succeeded), ‘degraded’ (mix of successes and failures), ‘failing’ (consecutive failures beyond threshold), ‘unknown’ (no delivery data yet).

Allowed values:
delivery_attemptslist of objects or null
Recent delivery attempts for this subscription.
secretstring or null

The signing secret for webhook signature verification. Only included when include_secret=true is passed to the API. Keep this secret secure.

Errors