Notification settings

Notification settings entities describe subscriptions to events. They're also called notification destinations.

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

Notification destinations tell Paddle which events that you want to get notifications for and where to deliver those notifications.

Notification destination entities hold information like:

The kind of notification destination.
The webhook endpoint or email address for this destination.
The API version used for data payloads.
Which event types you want to get notifications for.

They also include a secret key that you can use to make sure that webhooks came from Paddle. Paddle generates this for you when you create a notification destination.

You can add as many destinations as you like, but only 10 may be active at once.

Get a step-by-step overview of how to create a notification destination using the API or the dashboard. See: Work with notification destinations

Attributes

idstring

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

descriptionstring

Short description for this notification destination. Shown in the Paddle web app.

typestring

Where notifications should be sent for this destination.

destinationstring

Webhook endpoint URL or email address.

activeboolean

Whether Paddle should try to deliver events to this notification destination.

api_versioninteger

API version that returned objects for events should conform to. Must be a valid version of the Paddle API. Cannot be a version older than your account default.

include_sensitive_fieldsboolean

Whether potentially sensitive fields should be sent to this notification destination.

subscribed_eventsarray[object]

Represents an event type.

namestring

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

descriptionstring

Short description of this event type.

groupstring

Group for this event type. Typically the entity that this event relates to.

available_versionsarray[integer]

List of API versions that this event type supports.

endpoint_secret_keystring

Webhook destination secret key, prefixed with pdl_ntfset_. Used for signature verification.

traffic_sourcestring

Whether Paddle should deliver real platform events, simulation events or both to this notification destination.

List notification settings

gethttps://api.paddle.com/notification-settings

Create a notification setting

posthttps://api.paddle.com/notification-settings

Get a notification setting

gethttps://api.paddle.com/notification-settings/{notification_setting_id}

Update a notification setting

patchhttps://api.paddle.com/notification-settings/{notification_setting_id}

Delete a notification setting

deletehttps://api.paddle.com/notification-settings/{notification_setting_id}