Notifications

Notification entities describe a notification for an event that happened in your Paddle system.

You can get notifications for events that happen in your Paddle system by creating notification destinations.

When an event that you have a notification destination for occurs, Paddle creates a notification entity with information about the notification.

Notification entities hold information like:

What kind of event happened.
When it happened.
Whether the notification was delivered.
The event, including new or changed entity.

Keep in mind that a single event might create multiple notifications. This is common when working with multiple notification destinations that are subscribed to the same events. When an event occurs, Paddle creates a separate related notification entity for each notification destination. They'll share the same event_id, but have different a notification_id.

Create notification destination to get notifications for events. See: Work with notification destinations

Attributes

idstring

Unique Paddle ID for this notification, prefixed with ntf_.

typestring

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

statusstring

Status of this notification.

payloadobject

Notification payload. Includes the new or changed event.

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.

notification_idstring

Unique Paddle ID for this notification, prefixed with ntf_.

occurred_atstring<date-time>

RFC 3339 datetime string of when this notification occurred.

delivered_atstring<date-time> or null

RFC 3339 datetime string of when this notification was delivered. null if not yet delivered successfully.

replayed_atstring<date-time> or null

RFC 3339 datetime string of when this notification was replayed. null if not replayed.

originstring

Describes how this notification was created.

last_attempt_atstring<date-time> or null

RFC 3339 datetime string of when this notification was last attempted.

retry_atstring<date-time> or null

RFC 3339 datetime string of when this notification is scheduled to be retried.

times_attemptedinteger

How many times delivery of this notification has been attempted. Automatically incremented by Paddle after an attempt.

notification_setting_idstring

Unique Paddle ID for this notification setting, prefixed with ntfset_.

List notifications

gethttps://api.paddle.com/notifications

Get a notification

gethttps://api.paddle.com/notifications/{notification_id}

Replay a notification

posthttps://api.paddle.com/notifications/{notification_id}/replay