Paddle Billing
Search

List notification settings

Returns a list of notification settings (notification destinations).

The response is not paginated.

Response

dataarray[object]

Represents a notification destination.

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. Defaults to your account default if not included.

include_sensitive_fieldsboolean

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

subscribed_eventsarray[object]

Represents an event type.

endpoint_secret_keystring

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

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.