Update a notification setting

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

Updates a notification setting (notification destination) using its ID.

When updating subscribed events, send the complete list of event types that you'd like to subscribe to — including existing event types. If you omit event types, they're removed from the notification setting.

You only need to pass an event type name. Paddle responds with the full event type object for each event type.

If successful, your response includes a copy of the updated notification setting entity.

Path Parameters

notification_setting_idstringrequired

Paddle ID of the notification setting entity (notification destination) to work with.

Request Body

descriptionstring

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

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. Can't be a version older than your account default. Defaults to your account default if omitted.

include_sensitive_fieldsboolean

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

subscribed_eventsarray[string]

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.

traffic_sourcestring

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

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 dashboard.

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. Can't 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]

Subscribed events for this notification destination.

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
1{
2  "description": "Slack notifications (old)",
3  "active": false
4}

Response