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

Tools

Slug: PUSH_ALERT_ADD_SUBSCRIBERS_TO_SEGMENTAdd one or more Web Push subscribers to an existing segment.

Input Parameters

integer
required
Target segment ID.
array
required
One or more PushAlert subscriber IDs to add.

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: PUSH_ALERT_CREATE_SEGMENTCreate a Web Push subscriber segment with a letters-and-digits name.

Input Parameters

string
required
Segment name containing only ASCII letters and digits, at most 32 characters.

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: PUSH_ALERT_DELETE_SEGMENTPermanently delete a Web Push subscriber segment by ID.

Input Parameters

integer
required
ID of the segment to delete.

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: PUSH_ALERT_GET_NOTIFICATION_STATSGet attempted, delivered, clicked, and click-through-rate statistics for a Web Push notification.

Input Parameters

integer
required
Notification ID returned by a Web Push send operation.

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: PUSH_ALERT_GET_SUBSCRIBER_ATTRIBUTESGet custom attributes for a Web Push subscriber.

Input Parameters

string
required
PushAlert subscriber ID.

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: PUSH_ALERT_LIST_SEGMENTSList all Web Push subscriber segments and their subscriber counts.

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: PUSH_ALERT_REMOVE_SUBSCRIBERS_FROM_SEGMENTRemove one or more Web Push subscribers from an existing segment.

Input Parameters

integer
required
Target segment ID.
array
required
One or more PushAlert subscriber IDs to remove.

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: PUSH_ALERT_SEND_WEB_PUSH_NOTIFICATIONSend an irreversible Web Push notification to a saved segment, explicit subscriber IDs, or attribute-matched subscribers. If no targeting field is supplied, sends to every subscriber. Excludes paid rich-media, audience-creator, and scheduling options.

Input Parameters

string
required
Destination URL opened when the notification is clicked.
string
Optional HTTPS icon URL.
string
required
Notification title, at most 64 characters.
string
required
Notification message, at most 192 characters.
object
Exactly one subscriber attribute condition used for targeting.
integer
Saved segment to notify. When set, subscriber and attribute targeting must be omitted. Omit all targeting fields to notify every subscriber.
string
One PushAlert subscriber ID to notify; mutually exclusive with subscribers. Omit all targeting fields to notify every subscriber.
integer
Notification expiry in seconds for non-segment sends; defaults to 86400. Omit when segment_id is set.
array
Subscriber IDs to notify; mutually exclusive with subscriber.

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: PUSH_ALERT_SET_SUBSCRIBER_ATTRIBUTESAdd or update custom attributes for a Web Push subscriber.

Input Parameters

object
required
Attribute key-value pairs; keys are at most 32 characters and values are at most 128 characters.
string
required
PushAlert subscriber ID.

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