Create or update notification destinations

A notification destination is a webhook endpoint or email address that Paddle sends notifications about events to. It's called a notification setting in the API.

How it works

When something notable occurs in your system, Paddle creates an event entity with information about what happened and when. You use the list events operation in the API to get a paginated list of events that have occurred. This is sometimes called the event stream.

You can set up a notification destination to tell Paddle to deliver notifications when events occur. When an event occurs, Paddle sends a notification with the event payload to your notification destination — typically a webhook to your webhook endpoint server.

Events include the new or changed entity, along with information about when an event occurred. You can use notifications to keep your app in sync with Paddle, or to integrate with third-party systems. For example, you can subscribe to notifications for subscription.canceled, then make sure customers can't access a canceled subscription when you receive these notifications.

A notification is an instance of a delivery attempt for an event. A single event may create multiple notifications. For example, you can create two notification destinations configured for the same event. In this case, Paddle creates two notifications for each destination that share an event_id.

Create a notification destination

Create a notification destination to start receiving notifications for events. You can choose the kind of events that you want to receive notifications for.

You can create as many notification destinations as you want, but only 10 can be active at once.

Update a notification destination

Once you've created a notification destination, you can change its name, destination URL or email, what kind of traffic it receives, and the events received.

To change other fields, deactivate this notification destination and create another.

Deactivate a notification destination

Deactivate a notification destination to stop Paddle from sending notifications for events to it. Deactivation is useful if you need to make changes to a webhook endpoint server or integration. You can reactivate later, if needed.

Delete a notification destination

Delete a notification destination to permanently remove it from your Paddle system. Paddle stops sending notifications for events to your destination, and you'll lose access to all the logs for this notification destination.

There's no way to recover a deleted notification destination. Deactivate a notification destination if you'll need access to the logs or want to reactivate later on.

You can only delete notification destinations using the API.

Request

Send a DELETE request to the /notification-settings/{notification_setting_id} endpoint, passing the ID of the notification destination as a path parameter.

Response

If successful, Paddle returns 204 No Content with no response body.

Common errors

Related pages