Create a notification setting

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

Creates a new notification setting (notification destination).

Pass an array of event type names to subscribed_events to say which events you'd like to subscribe to. Paddle responds with the full event type object for each event type.

If successful, your response includes a copy of the new notification setting entity. Use the returned endpoint_secret_key for webhook signature verification.

Request Body

descriptionstringrequired

Short description for this notification destination. Shown in the Paddle Dashboard.

destinationstringrequired

Webhook endpoint URL or email address.

subscribed_eventsarray[string]required

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

typestringrequired

Where notifications should be sent for this 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. If omitted, defaults to your account default version.

include_sensitive_fieldsboolean

Whether potentially sensitive fields should be sent to this notification destination. If omitted, defaults to false.

traffic_sourcestring

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

Response

dataobject

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.

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.

traffic_sourcestring

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

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.

Request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
1{
2  "description": "Slack notifications",
3  "type": "url",
4  "destination": "https://hooks.slack.com/example",
5  "api_version": 1,
6  "traffic_source": "all",
7  "subscribed_events": [
8    "transaction.billed",
9    "transaction.canceled",
10    "transaction.completed",
11    "transaction.created",
12    "transaction.payment_failed",
13    "transaction.ready",
14    "transaction.updated",
15    "subscription.activated",
16    "subscription.created",
17    "subscription.past_due",
18    "subscription.paused",
19    "subscription.resumed",
20    "subscription.trialing",

Response