Work with notification destinations

Create notification destinations to tell Paddle which events you'd like to receive and where to deliver them to. Once added, you can update, deactivate and reactivate, and delete destinations.

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

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, when a subscription cancels, Paddle can send a subscription.canceled notification as a webhook. When you receive this event, you can provision your app to make sure the canceled customer can no longer access your app.

A notification is an instance of a delivery attempt for an event. A single event may create multiple notifications. For example, if you have two notification destinations configured for the same event then Paddle creates two notifications 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'd like to receive notifications for.

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

Web

API

Create new destination

Go to Paddle > Developer Tools > Notifications.
Click New destination.

Screenshot showing the Notifications screen in the Paddle web app. Developer Tools > Notifications is called out on the nav, and the 'New destination' button is also called out.

Enter details

Enter the details for your new notification destination.

Fields

Description	Short description for this notification destination.
Notification type	Whether you'd like to send events to a webhook endpoint or an email address.
URL or email	Webhook endpoint URL or email address to send events to.
API version	API version that returned objects for events should conform to.

Screenshot showing the new notification destination drawer in the Paddle web app. The details section is called out.

Choose events and save

Choose the events that you'd like to receive notifications for.
Click Save destination when you're done.

Screenshot showing the new notification destination drawer in the Paddle web app. The events section is called out.

Update a notification destination

Once you've created a notification destination, you can change its name, destination URL or email, whether sensitive fields are included, and the events received.

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

Web

API

Edit destination

Go to Paddle > Developer Tools > Notifications.
Click the … next to a notification destination in the list, then choose Edit destination from the menu.

Screenshot showing the Notifications screen in the Paddle web app. Developer tools > Notifications is called out on the nav. The menu for the first notification in the list is open, and the 'Edit destination' option is selected.

Change details and save

Edit notification destination details and events.
Click Update destination when you're done.

Screenshot showing the edit notification destination drawer in the Paddle web app. The 'update destination' button is called out.

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.

Web

API

Go to Paddle > Developer Tools > Notifications.
Click the … next to a notification destination in the list, then choose Deactivate from the menu.

You can reactivate later by choosing Activate from the menu.

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.

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

notification_setting_idstring

Paddle ID of the notification entity to work with.

Find notification destination ID

Response

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

Verify webhook signatures

Notification settings entity overview

List event types operation

Sign up to get notified when our API evolves