Docs

client_token.created

Occurs when a client-side token is created.

Occurs when a client-side token is created. Client-side tokens are used to authenticate Paddle.js. Pass the token field as the token parameter when initializing Paddle.js.

client_token.updated or client_token.revoked may occur later in the token's lifecycle.

event_idstringrequired
Example: evt_01gks14ge726w50ch2tmaw2a1x
Unique Paddle ID for this event, prefixed with evt_.
Pattern: ^evt_[a-z\d]{26}$
event_typestringrequired
Type of event sent by Paddle, in the format entity.event_type.
Values
+ Show all values
occurred_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this event occurred.
notification_idstringrequired
Example: ntf_01ghbkd0frb9k95cnhwd1bxpvk
Unique Paddle ID for this notification, prefixed with ntf_.
Pattern: ^ntf_[a-z\d]{26}$
dataobjectrequired
New or changed entity.
idstringrequired
Example: ctkn_01ghbkd0frb9k95cnhwd1bxpvk
Unique Paddle ID for this client-side token entity, prefixed with ctkn_.
Pattern: ^ctkn_[a-z\d]{26}$
tokenstringrequired
A client-side token, prefixed with test or live depending on the environment of your account. Pass as the token parameter when initializing Paddle.js to authenticate.
namestringrequired
Short name of this client-side token. Typically unique and human-identifiable.
Length: 1–150
descriptionstring | nullrequired
Short description of this client-side token. Typically gives details about what the token is used for and where it's used.
Length: 1–500
statusstringrequired
Status of this client-side token.
Values
  • active
    Client-side token is active. The token can be used to authenticate Paddle.js.
  • revoked
    Client-side token is revoked. The token can't be used to authenticate Paddle.js.
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
revoked_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string.
client_token.created
{
  "event_id": "evt_01jkdr0rc527wcjdg1txsdxhtf",
  "event_type": "client_token.created",
  "occurred_at": "2025-06-26T14:36:14.695521Z",
  "notification_id": "ntf_01jkdr1mgbe62eqkh3p0fq8b0h",
  "data": {
    "id": "ctkn_01ghbkd0frb9k95cnhwd1bxpvk",
    "token": "live_7d279f61a3499fed520f7cd8c08",
    "name": "Pricing page integration",
    "description": "Used to display prices and open checkout within our pricing page on our marketing domain.",
    "status": "active",
    "created_at": "2025-06-26T14:36:14.695521Z",
    "updated_at": "2025-06-26T14:36:14.695521Z",
    "revoked_at": null
  }
}

Was this page helpful?