Create a notification setting
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
Short description for this notification destination. Shown in the Paddle Dashboard.
Webhook endpoint URL or email address.
Subscribed events for this notification destination. When creating or updating a notification destination, pass an array of event type names only. Paddle returns the complete event type object.
Where notifications should be sent for this destination.
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.
Whether potentially sensitive fields should be sent to this notification destination.
Response
Represents a notification destination.
Unique Paddle ID for this notification setting, prefixed with ntfset_
.
Short description for this notification destination. Shown in the Paddle web app.
Where notifications should be sent for this destination.
Webhook endpoint URL or email address.
Whether Paddle should try to deliver events to this notification destination.
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.
Whether potentially sensitive fields should be sent to this notification destination.
Represents an event type.
Webhook destination secret key, prefixed with pdl_ntfset_
. Used for signature verification.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
12345678910111213141516171819201{
2 "description": "Slack notifications",
3 "type": "url",
4 "destination": "https://hooks.slack.com/example",
5 "api_version": 1,
6 "include_sensitive_fields": false,
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",