> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Webpushr

> Webpushr enables websites to send push notification campaigns to all subscribers, segments, custom audiences, or individual subscribers and monitor campaign delivery.

![Webpushr logo](https://mintcdn.com/composio-preview/DMB8UrgJmE7r-ZQ5/images/toolkits/webpushr.svg?fit=max\&auto=format\&n=DMB8UrgJmE7r-ZQ5\&q=85\&s=fc7fe060293cb6be589e725ac1582355)

* **Category:** notifications
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 6
* **Triggers:** 0
* **Slug:** `WEBPUSHR`
* **Version:** 20261030\_00

## Tools

> [accordion] Get Notification Status
>
> **Slug:** `WEBPUSHR_GET_NOTIFICATION_STATUS`
>
> Get delivery and engagement counts for a Webpushr notification campaign using its campaign ID.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> Campaign ID returned by a Webpushr campaign-creation tool. Preserve the ID as a string.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Subscriber Count
>
> **Slug:** `WEBPUSHR_GET_SUBSCRIBER_COUNT`
>
> Return lifetime and currently active subscriber counts for the connected Webpushr site.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Notification to All Subscribers
>
> **Slug:** `WEBPUSHR_SEND_NOTIFICATION_TO_ALL`
>
> Create or schedule a push notification campaign for every subscriber of the connected Webpushr site. This can notify the entire audience and should only be called with explicit user intent.
>
> #### Input Parameters
>
> **icon** `string`
>
> HTTPS URL of a 192x192 PNG notification icon.
>
> **name** `string`
>
> Internal campaign name for reports and dashboard views, up to 100 characters.
>
> **image** `string`
>
> HTTPS URL of a large notification image; not supported by every browser.
>
> **title** `string` *required*
>
> Notification title, up to 100 characters.
>
> **message** `string` *required*
>
> Notification body, up to 255 characters.
>
> **send\_at** `string`
>
> Future scheduled date and time with UTC offset; must be at least five minutes in the future.
>
> **auto\_hide** `integer ("0" | "1")`
>
> Set to 1 to close the notification automatically after a few seconds, or 0 to keep it visible.
>
> **target\_url** `string` *required*
>
> URL to open when a subscriber clicks the notification, up to 255 characters.
>
> **expire\_push** `string`
>
> Offline delivery lifetime using digits plus m, h, or d, such as 5m or 50d; Webpushr defaults to four weeks when omitted.
>
> **action\_buttons** `array`
>
> Optional notification buttons; each requires a title and destination URL. Browser support varies.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Notification by Attributes
>
> **Slug:** `WEBPUSHR_SEND_NOTIFICATION_TO_ATTRIBUTES`
>
> Create or schedule a push notification campaign for subscribers matching any supplied custom attribute key/value pair.
>
> #### Input Parameters
>
> **icon** `string`
>
> HTTPS URL of a 192x192 PNG notification icon.
>
> **name** `string`
>
> Internal campaign name for reports and dashboard views, up to 100 characters.
>
> **title** `string` *required*
>
> Notification title, up to 100 characters.
>
> **message** `string` *required*
>
> Notification body, up to 255 characters.
>
> **send\_at** `string`
>
> Future scheduled date and time with UTC offset; must be at least five minutes in the future.
>
> **auto\_hide** `integer ("0" | "1")`
>
> Set to 1 to close the notification automatically after a few seconds, or 0 to keep it visible.
>
> **attributes** `object` *required*
>
> Custom attribute key/value pairs used with OR semantics: a subscriber matching any pair receives the notification. Send a JSON object, not a list.
>
> **target\_url** `string` *required*
>
> URL to open when a subscriber clicks the notification, up to 255 characters.
>
> **expire\_push** `string`
>
> Offline delivery lifetime using digits plus m, h, or d, such as 5m or 50d. Webpushr defaults to four weeks when omitted.
>
> **action\_buttons** `array`
>
> Optional notification buttons. Each requires a title and destination URL; browser support varies.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Notification to Segments
>
> **Slug:** `WEBPUSHR_SEND_NOTIFICATION_TO_SEGMENTS`
>
> Create or schedule a push notification campaign for subscribers in one or more Webpushr segments. This sends to every subscriber in the selected segments and should only be called with explicit user intent.
>
> #### Input Parameters
>
> **icon** `string`
>
> HTTPS URL of a 192x192 PNG notification icon.
>
> **name** `string`
>
> Internal campaign name for reports and dashboard views, up to 100 characters.
>
> **image** `string`
>
> HTTPS URL of a large notification image; not supported by every browser.
>
> **title** `string` *required*
>
> Notification title, up to 100 characters.
>
> **message** `string` *required*
>
> Notification body, up to 255 characters.
>
> **send\_at** `string`
>
> Future scheduled date and time with UTC offset; must be at least five minutes in the future.
>
> **auto\_hide** `integer ("0" | "1")`
>
> Set to 1 to close the notification automatically after a few seconds, or 0 to keep it visible.
>
> **target\_url** `string` *required*
>
> URL to open when a subscriber clicks the notification, up to 255 characters.
>
> **expire\_push** `string`
>
> Offline delivery lifetime using digits plus m, h, or d, such as 5m or 50d; Webpushr defaults to four weeks when omitted.
>
> **segment\_ids** `array` *required*
>
> One or more segment IDs from the Webpushr dashboard whose subscribers should receive the notification.
>
> **action\_buttons** `array`
>
> Optional notification buttons; each requires a title and destination URL, each up to 100 characters. Browser support varies.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Notification to Subscriber
>
> **Slug:** `WEBPUSHR_SEND_NOTIFICATION_TO_SUBSCRIBER`
>
> Send or schedule a push notification to one Webpushr subscriber ID. Use only when the intended recipient's subscriber ID is known.
>
> #### Input Parameters
>
> **icon** `string`
>
> HTTPS URL of a 192x192 PNG notification icon.
>
> **title** `string` *required*
>
> Notification title, up to 100 characters.
>
> **message** `string` *required*
>
> Notification body, up to 255 characters.
>
> **send\_at** `string`
>
> Future scheduled date and time with UTC offset, at least five minutes in the future, such as 2026-08-11 13:30 -08:00.
>
> **auto\_hide** `integer ("0" | "1")`
>
> Set to 1 to close the notification automatically after a few seconds, or 0 to keep it visible.
>
> **target\_url** `string` *required*
>
> HTTP or HTTPS URL opened when the subscriber clicks the notification, up to 255 characters.
>
> **expire\_push** `string`
>
> Offline delivery lifetime using digits followed by m, h, or d, such as 5m or 50d. Webpushr defaults to four weeks when omitted.
>
> **subscriber\_id** `string` *required*
>
> Webpushr subscriber ID. Preserve this value as a string.
>
> **action\_buttons** `array`
>
> Optional notification action buttons. Browser support varies.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
