> ## 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.

# PushAlert

> Send and manage Web Push notifications, subscriber segments, attributes, and automation for a PushAlert website project.

![PushAlert logo](https://mintcdn.com/composio-preview/HvfZXDijhFOaKyF5/images/toolkits/push_alert.svg?fit=max\&auto=format\&n=HvfZXDijhFOaKyF5\&q=85\&s=3cd996bc1a39367c9385f59724b8ea3b)

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

## Tools

> [accordion] Add Subscribers to Segment
>
> **Slug:** `PUSH_ALERT_ADD_SUBSCRIBERS_TO_SEGMENT`
>
> Add one or more Web Push subscribers to an existing segment.
>
> #### Input Parameters
>
> **segment\_id** `integer` *required*
>
> Target segment ID.
>
> **subscriber\_ids** `array` *required*
>
> One or more PushAlert subscriber IDs to add.
>
> #### 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] Create Segment
>
> **Slug:** `PUSH_ALERT_CREATE_SEGMENT`
>
> Create a Web Push subscriber segment with a letters-and-digits name.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Segment name containing only ASCII letters and digits, at most 32 characters.
>
> #### 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] Delete Segment
>
> **Slug:** `PUSH_ALERT_DELETE_SEGMENT`
>
> Permanently delete a Web Push subscriber segment by ID.
>
> #### Input Parameters
>
> **segment\_id** `integer` *required*
>
> ID of the segment to delete.
>
> #### 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 Notification Stats
>
> **Slug:** `PUSH_ALERT_GET_NOTIFICATION_STATS`
>
> Get attempted, delivered, clicked, and click-through-rate statistics for a Web Push notification.
>
> #### Input Parameters
>
> **notification\_id** `integer` *required*
>
> Notification ID returned by a Web Push send operation.
>
> #### 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 Attributes
>
> **Slug:** `PUSH_ALERT_GET_SUBSCRIBER_ATTRIBUTES`
>
> Get custom attributes for a Web Push subscriber.
>
> #### Input Parameters
>
> **subscriber\_id** `string` *required*
>
> PushAlert subscriber ID.
>
> #### 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] List Segments
>
> **Slug:** `PUSH_ALERT_LIST_SEGMENTS`
>
> List all Web Push subscriber segments and their subscriber counts.
>
> #### 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] Remove Subscribers from Segment
>
> **Slug:** `PUSH_ALERT_REMOVE_SUBSCRIBERS_FROM_SEGMENT`
>
> Remove one or more Web Push subscribers from an existing segment.
>
> #### Input Parameters
>
> **segment\_id** `integer` *required*
>
> Target segment ID.
>
> **subscriber\_ids** `array` *required*
>
> One or more PushAlert subscriber IDs to remove.
>
> #### 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 Web Push Notification
>
> **Slug:** `PUSH_ALERT_SEND_WEB_PUSH_NOTIFICATION`
>
> Send 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
>
> **url** `string` *required*
>
> Destination URL opened when the notification is clicked.
>
> **icon** `string`
>
> Optional HTTPS icon URL.
>
> **title** `string` *required*
>
> Notification title, at most 64 characters.
>
> **message** `string` *required*
>
> Notification message, at most 192 characters.
>
> **attributes** `object`
>
> Exactly one subscriber attribute condition used for targeting.
>
> **segment\_id** `integer`
>
> Saved segment to notify. When set, subscriber and attribute targeting must be omitted. Omit all targeting fields to notify every subscriber.
>
> **subscriber** `string`
>
> One PushAlert subscriber ID to notify; mutually exclusive with subscribers. Omit all targeting fields to notify every subscriber.
>
> **expire\_time** `integer`
>
> Notification expiry in seconds for non-segment sends; defaults to 86400. Omit when segment\_id is set.
>
> **subscribers** `array`
>
> Subscriber IDs to notify; mutually exclusive with subscriber.
>
> #### 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] Set Subscriber Attributes
>
> **Slug:** `PUSH_ALERT_SET_SUBSCRIBER_ATTRIBUTES`
>
> Add or update custom attributes for a Web Push subscriber.
>
> #### Input Parameters
>
> **attributes** `object` *required*
>
> Attribute key-value pairs; keys are at most 32 characters and values are at most 128 characters.
>
> **subscriber\_id** `string` *required*
>
> PushAlert subscriber ID.
>
> #### 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
