api_key.created

Occurs when an API key is created.

event_idstring

Unique Paddle ID for this event, prefixed with evt_.

event_typestring

Type of event sent by Paddle, in the format entity.event_type.

occurred_atstring<date-time>

RFC 3339 datetime string of when this event occurred.

dataobject

New or changed entity.

idstring

Unique Paddle ID for this API key entity, prefixed with apikey_.

namestring

Short name of this API key. Typically unique and human-identifiable.

descriptionstring or null

Short description of this API key. Typically gives details about what the API key is used for and where it's used.

keystring

An obfuscated version of this API key, prefixed with pdl_ and containing _apikey_ .

statusstring

Status of this API key.

permissionsarray[string]

Permissions assigned to this API key. Determines what actions the API key can perform.

expires_atstring<date-time> or null

RFC 3339 datetime string of when this API key expires.

last_used_atstring<date-time> or null

RFC 3339 datetime string of when this API key was last used (accurate to within 1 hour). null if never used.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

notification_idstring

Unique Paddle ID for this notification, prefixed with ntf_.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
1{
2  "event_id": "evt_01jkdr0rc527wcjdg1txsdxhtf",
3  "event_type": "api_key.created",
4  "occurred_at": "2025-03-26T06:58:38.517522Z",
5  "notification_id": "ntf_01jkdr1mgbe62eqkh3p0fq8b0h",
6  "data": {
7    "id": "apikey_01jkdpbhazdpn3wpcya45as9tg",
8    "name": "CRM integration",
9    "description": "Used to authenticate with the API for storing Paddle customer data in our CRM.",
10    "status": "active",
11    "key": "pdl_live_apikey_01jkdpbhaz****",
12    "permissions": [
13      "address.read",
14      "business.read",
15      "customer.read",
16      "subscription.read",
17      "transaction.read"
18    ],
19    "expires_at": "2025-06-26T06:58:38.517522Z",
20    "last_used_at": null,