---
canonical_url: "https://docs.composio.dev/toolkits/webpushr"
markdown_url: "https://docs.composio.dev/toolkits/webpushr.md"
product: "platform"
version: null
last_updated: null
---

# Webpushr

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

- **Category:** notifications
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 6
- **Triggers:** 0
- **Slug:** `WEBPUSHR`
- **Version:** 00000000_00

## Tools

### Get Notification Status

**Slug:** `WEBPUSHR_GET_NOTIFICATION_STATUS`

Get delivery and engagement counts for a Webpushr notification campaign using its campaign ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | Campaign ID returned by a Webpushr campaign-creation tool. Preserve the ID as a string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subscriber Count

**Slug:** `WEBPUSHR_GET_SUBSCRIBER_COUNT`

Return lifetime and currently active subscriber counts for the connected Webpushr site.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `icon` | string | No | HTTPS URL of a 192x192 PNG notification icon. |
| `name` | string | No | Internal campaign name for reports and dashboard views, up to 100 characters. |
| `image` | string | No | HTTPS URL of a large notification image; not supported by every browser. |
| `title` | string | Yes | Notification title, up to 100 characters. |
| `message` | string | Yes | Notification body, up to 255 characters. |
| `send_at` | string | No | Future scheduled date and time with UTC offset; must be at least five minutes in the future. |
| `auto_hide` | integer ("0" | "1") | No | Set to 1 to close the notification automatically after a few seconds, or 0 to keep it visible. |
| `target_url` | string | Yes | URL to open when a subscriber clicks the notification, up to 255 characters. |
| `expire_push` | string | No | 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 | No | Optional notification buttons; each requires a title and destination URL. Browser support varies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `icon` | string | No | HTTPS URL of a 192x192 PNG notification icon. |
| `name` | string | No | Internal campaign name for reports and dashboard views, up to 100 characters. |
| `title` | string | Yes | Notification title, up to 100 characters. |
| `message` | string | Yes | Notification body, up to 255 characters. |
| `send_at` | string | No | Future scheduled date and time with UTC offset; must be at least five minutes in the future. |
| `auto_hide` | integer ("0" | "1") | No | Set to 1 to close the notification automatically after a few seconds, or 0 to keep it visible. |
| `attributes` | object | Yes | 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 | Yes | URL to open when a subscriber clicks the notification, up to 255 characters. |
| `expire_push` | string | No | 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 | No | Optional notification buttons. Each requires a title and destination URL; browser support varies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `icon` | string | No | HTTPS URL of a 192x192 PNG notification icon. |
| `name` | string | No | Internal campaign name for reports and dashboard views, up to 100 characters. |
| `image` | string | No | HTTPS URL of a large notification image; not supported by every browser. |
| `title` | string | Yes | Notification title, up to 100 characters. |
| `message` | string | Yes | Notification body, up to 255 characters. |
| `send_at` | string | No | Future scheduled date and time with UTC offset; must be at least five minutes in the future. |
| `auto_hide` | integer ("0" | "1") | No | Set to 1 to close the notification automatically after a few seconds, or 0 to keep it visible. |
| `target_url` | string | Yes | URL to open when a subscriber clicks the notification, up to 255 characters. |
| `expire_push` | string | No | 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 | Yes | One or more segment IDs from the Webpushr dashboard whose subscribers should receive the notification. |
| `action_buttons` | array | No | Optional notification buttons; each requires a title and destination URL, each up to 100 characters. Browser support varies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `icon` | string | No | HTTPS URL of a 192x192 PNG notification icon. |
| `title` | string | Yes | Notification title, up to 100 characters. |
| `message` | string | Yes | Notification body, up to 255 characters. |
| `send_at` | string | No | 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") | No | Set to 1 to close the notification automatically after a few seconds, or 0 to keep it visible. |
| `target_url` | string | Yes | HTTP or HTTPS URL opened when the subscriber clicks the notification, up to 255 characters. |
| `expire_push` | string | No | 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 | Yes | Webpushr subscriber ID. Preserve this value as a string. |
| `action_buttons` | array | No | Optional notification action buttons. Browser support varies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |