list_notification_settings
Read-only
Retrieve and manage notification settings in Paddle Billing, with options to filter by active status, traffic source, and paginate results for comprehensive configuration review.
Instructions
This tool will list notification settings in Paddle.
Use the maximum perPage by default (200) to ensure comprehensive results. Filter notification settings by active and trafficSource as needed. Results are paginated - use the 'after' parameter with the last ID from previous results to get the next page. Sort and order results using the orderBy parameter.
The endpointSecretKey is returned for webhook signature verification, but is a secure value and should never be shared, never be made publicly-accessible, and should only be stored securely.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | Return entities after the specified Paddle ID when working with paginated endpoints. | |
| perPage | No | Set how many entities are returned per page. Returns the maximum number of results if a number greater than the maximum is requested. | |
| orderBy | No | Order returned entities by the specified field and direction. | |
| active | No | Determine whether returned entities are active (`true`) or not (`false`). | |
| trafficSource | No | Return entities that match the specified traffic source. |
Implementation Reference
- src/functions.ts:438-448 (handler)The handler function that executes the tool logic by calling paddle.notificationSettings.list(params) and handling errors.
export const listNotificationSettings = async ( paddle: Paddle, params: z.infer<typeof Parameters.listNotificationSettingsParameters>, ) => { try { const result = await paddle.notificationSettings.list(params); return result; } catch (error) { return error; } }; - src/tools.ts:686-696 (schema)Tool schema definition including method name, description, parameters schema reference, and required actions.
method: "list_notification_settings", name: "List notification settings", description: prompts.listNotificationSettingsPrompt, parameters: params.listNotificationSettingsParameters, actions: { notificationSettings: { read: true, list: true, }, }, }, - src/api.ts:45-45 (registration)Registration of the tool handler function in the toolMap for execution.
[TOOL_METHODS.LIST_NOTIFICATION_SETTINGS]: funcs.listNotificationSettings, - src/constants.ts:37-37 (helper)Constant defining the tool method string identifier.
LIST_NOTIFICATION_SETTINGS: "list_notification_settings",