Skip to main content
Webpushr logo
  • Category: notifications
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 6
  • Triggers: 0
  • Slug: WEBPUSHR
  • Version: 20261030_00

Tools

Slug: WEBPUSHR_GET_NOTIFICATION_STATUSGet delivery and engagement counts for a Webpushr notification campaign using its campaign ID.

Input Parameters

string
required
Campaign ID returned by a Webpushr campaign-creation tool. Preserve the ID as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WEBPUSHR_GET_SUBSCRIBER_COUNTReturn lifetime and currently active subscriber counts for the connected Webpushr site.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WEBPUSHR_SEND_NOTIFICATION_TO_ALLCreate 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

string
HTTPS URL of a 192x192 PNG notification icon.
string
Internal campaign name for reports and dashboard views, up to 100 characters.
string
HTTPS URL of a large notification image; not supported by every browser.
string
required
Notification title, up to 100 characters.
string
required
Notification body, up to 255 characters.
string
Future scheduled date and time with UTC offset; must be at least five minutes in the future.
integer ("0" | "1")
Set to 1 to close the notification automatically after a few seconds, or 0 to keep it visible.
string
required
URL to open when a subscriber clicks the notification, up to 255 characters.
string
Offline delivery lifetime using digits plus m, h, or d, such as 5m or 50d; Webpushr defaults to four weeks when omitted.
array
Optional notification buttons; each requires a title and destination URL. Browser support varies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WEBPUSHR_SEND_NOTIFICATION_TO_ATTRIBUTESCreate or schedule a push notification campaign for subscribers matching any supplied custom attribute key/value pair.

Input Parameters

string
HTTPS URL of a 192x192 PNG notification icon.
string
Internal campaign name for reports and dashboard views, up to 100 characters.
string
required
Notification title, up to 100 characters.
string
required
Notification body, up to 255 characters.
string
Future scheduled date and time with UTC offset; must be at least five minutes in the future.
integer ("0" | "1")
Set to 1 to close the notification automatically after a few seconds, or 0 to keep it visible.
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.
string
required
URL to open when a subscriber clicks the notification, up to 255 characters.
string
Offline delivery lifetime using digits plus m, h, or d, such as 5m or 50d. Webpushr defaults to four weeks when omitted.
array
Optional notification buttons. Each requires a title and destination URL; browser support varies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WEBPUSHR_SEND_NOTIFICATION_TO_SEGMENTSCreate 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

string
HTTPS URL of a 192x192 PNG notification icon.
string
Internal campaign name for reports and dashboard views, up to 100 characters.
string
HTTPS URL of a large notification image; not supported by every browser.
string
required
Notification title, up to 100 characters.
string
required
Notification body, up to 255 characters.
string
Future scheduled date and time with UTC offset; must be at least five minutes in the future.
integer ("0" | "1")
Set to 1 to close the notification automatically after a few seconds, or 0 to keep it visible.
string
required
URL to open when a subscriber clicks the notification, up to 255 characters.
string
Offline delivery lifetime using digits plus m, h, or d, such as 5m or 50d; Webpushr defaults to four weeks when omitted.
array
required
One or more segment IDs from the Webpushr dashboard whose subscribers should receive the notification.
array
Optional notification buttons; each requires a title and destination URL, each up to 100 characters. Browser support varies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WEBPUSHR_SEND_NOTIFICATION_TO_SUBSCRIBERSend or schedule a push notification to one Webpushr subscriber ID. Use only when the intended recipient’s subscriber ID is known.

Input Parameters

string
HTTPS URL of a 192x192 PNG notification icon.
string
required
Notification title, up to 100 characters.
string
required
Notification body, up to 255 characters.
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.
integer ("0" | "1")
Set to 1 to close the notification automatically after a few seconds, or 0 to keep it visible.
string
required
HTTP or HTTPS URL opened when the subscriber clicks the notification, up to 255 characters.
string
Offline delivery lifetime using digits followed by m, h, or d, such as 5m or 50d. Webpushr defaults to four weeks when omitted.
string
required
Webpushr subscriber ID. Preserve this value as a string.
array
Optional notification action buttons. Browser support varies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not