---
title: "Get the webhook event envelope schema"
method: GET
path: "/v1/sdk/webhooks/event-schema"
tags: ["Webhooks"]
---

# Get the webhook event envelope schema

`GET /v1/sdk/webhooks/event-schema`

Returns a representative example of the signed webhook payload every endpoint receives. Useful when building and type-checking a webhook handler; the live `type` will be one of the values from `event-types`.

## Response `200`

- WebhookEventDto
  - `api_version` string, required — API version that produced the event payload.
  - `created` number, required — Unix timestamp (seconds) when the event was created.
  - `data` WebhookEventDataDto, required
    - `object` object, required — The resource that the event relates to.
    - `previous_attributes` object, nullable — For *.updated events, the previous values of changed attributes.
  - `id` string, required — Unique event ID.
  - `livemode` boolean, required — True for live-mode events, false for sandbox.
  - `request` WebhookEventRequestDto, required
    - `id` object, nullable, required — ID of the API request that triggered the event.
    - `idempotency_key` object, nullable, required — Idempotency key of the triggering request.
  - `type` 'customer.created' | 'customer.updated' | 'customer.deleted' | 'purchase.created' | 'purchase.activated' | 'purchase.updated' | 'purchase.trial_ending' | 'purchase.trial_converted' | 'purchase.suspended' | 'purchase.past_due' | 'purchase.cancellation_scheduled' | 'purchase.cancelled' | 'purchase.reactivated' | 'purchase.expired' | 'purchase.renewed' | 'purchase.renewal_reminder' | 'purchase.refunded' | 'purchase.plan_changed' | 'payment.succeeded' | 'payment.failed' | 'payment.refunded' | 'payment.refund_failed' | 'payment.refund_pending' | 'payment.canceled' | 'payment.disputed' | 'payment.dispute_closed' | 'payout.paid' | 'payout.failed' | 'checkout_session.created' | 'checkout_session.completed' | 'checkout_session.expired' | 'customer.credit.topped_up' | 'customer.credit.low_balance' | 'customer.credit.exhausted' | 'customer.credit.debited' | 'customer.credit.granted' | 'customer.credit.adjusted' | 'customer.credit.auto_topup_failed' | 'usage.charged' | 'usage.recorded' | 'usage.reset' | 'product.created' | 'product.updated' | 'product.archived' | 'plan.created' | 'plan.updated' | 'plan.archived', required — Event type.

---

[API](https://skmtc.net/solvapay/apis/solvapay-rest-api.md) · [All operations](https://skmtc.net/solvapay/apis/solvapay-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/solvapay/solvapay-rest-api/versions/bbc2ff2bc849/schema)