# Pushover

Pushover is a service that enables real-time notifications to your devices through simple API integration.

- **Category:** notifications
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 29
- **Triggers:** 0
- **Slug:** `PUSHOVER`
- **Version:** 20260307_00

## Tools

### Cancel Receipt Retries

**Slug:** `PUSHOVER_CANCEL_RECEIPT_RETRIES`

Tool to cancel further retries for an emergency-priority message before its expiry. Use when you no longer want Pushover to keep attempting delivery of an urgent notification.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | Your Pushover application API token |
| `receipt` | string | Yes | The receipt ID returned when the message was first sent |

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

### Cancel Retries by Tag

**Slug:** `PUSHOVER_CANCEL_RETRIES_BY_TAG`

Tool to cancel retries for all active emergency-priority Pushover messages matching a specific tag. Use after sending emergency messages when you want to stop further retries for a given tag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | Tag assigned to messages when originally sent; identifies which receipts to cancel. |
| `token` | string | Yes | Application API token for authentication. |

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

### Client Acknowledge Delete Up To ID

**Slug:** `PUSHOVER_CLIENT_ACK_DELETE_UP_TO_ID`

Tool to delete/acknowledge device messages up to a specific message ID. Use when you want to clear all messages up to a known ID; call after retrieving the latest message ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secret` | string | Yes | User session secret obtained at login; required for Open Client actions. |
| `message` | integer | Yes | Highest message ID previously seen; all messages up to and including this ID are deleted. |
| `device_id` | string | Yes | The unique device ID returned during Device Registration. |

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

### Fetch Pending Messages

**Slug:** `PUSHOVER_CLIENT_FETCH_MESSAGES`

Tool to download pending messages for a registered device. Use after device registration to retrieve messages queued server-side.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secret` | string | Yes | User session secret obtained after login, required to authenticate the client. |
| `device_id` | string | Yes | Unique identifier of the registered device to fetch messages for. |

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

### Pushover Client Login

**Slug:** `PUSHOVER_CLIENT_LOGIN`

Tool to authenticate a Pushover user by email and password. Use when you need to obtain a user key and session secret. Include twofa code if prompted by a prior HTTP 412 response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Pushover account e-mail; case-sensitive |
| `twofa` | string | No | Two-factor authentication code; include only after prior HTTP 412 response |
| `password` | string | Yes | Pushover account password; case-sensitive |

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

### Client Realtime WebSocket Connection

**Slug:** `PUSHOVER_CLIENT_REALTIME_WEBSOCKET`

Tool to establish a secure WebSocket connection for real-time message notifications. Use after obtaining device ID and secret to receive instant push events.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secret` | string | Yes | Your user session secret for login |
| `timeout` | integer | No | Maximum time in seconds to listen for events before closing |
| `device_id` | string | Yes | Your Pushover client device ID for login |

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

### Register Open Client Device

**Slug:** `PUSHOVER_CLIENT_REGISTER_DEVICE`

Tool to register an Open Client desktop device. Use when you have a session secret from users/login to obtain a device ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `os` | string | No | Must be 'O' (capital letter O) for Open Client. |
| `name` | string | Yes | Short device name; allowed characters are letters, numbers, underscore, hyphen; max length 25. |
| `secret` | string | Yes | User session secret obtained from users/login; must be included. |

#### 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 Application Icon Image

**Slug:** `PUSHOVER_GET_APP_ICON_IMAGE`

Tool to fetch an application icon PNG by icon identifier. Use when you need to retrieve and cache the Pushover app icon image.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `icon` | string | Yes | Icon identifier string (from message object's 'icon' field). |

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

**Slug:** `PUSHOVER_GET_APP_LIMITS`

Tool to retrieve the current monthly message limit, remaining messages, and reset time for a Pushover application. Use when monitoring your monthly quota before sending messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | Your Pushover application API token. |

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

**Slug:** `PUSHOVER_GET_APP_TOKEN`

Tool to fetch stored Pushover application API token. Use when supplying credentials to other Pushover actions securely.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | No | Optional override for the Pushover application API token. If provided, this value will be returned. |

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

**Slug:** `PUSHOVER_GET_RECEIPT_STATUS`

Tool to poll the status of an emergency-priority notification receipt. Use after sending an emergency notification to check its delivery and acknowledgment. Use when you have the `receipt` from an emergency-priority message and need to track its retries and acknowledgment status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | Your application API token for Pushover. |
| `receipt` | string | Yes | 30-character alphanumeric receipt returned when sending an emergency-priority message. |

#### 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 Team API Token

**Slug:** `PUSHOVER_GET_TEAM_API_TOKEN`

Tool to fetch stored Pushover for Teams API token. Use when supplying team credentials to other Pushover Teams actions securely.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | No | Optional override for the Pushover team API token. If provided, this value will be returned. |

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

### Glances Update

**Slug:** `PUSHOVER_GLANCES_UPDATE`

Tool to update a user's Glances widget data without sending a notification. Use after preparing glance data fields: title, text, subtext, count, or percent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | Main line of data (max 100 characters). |
| `user` | string | Yes | The recipient user's Pushover user key. |
| `count` | integer | No | Count value for smaller screens; may be negative. |
| `title` | string | No | Short label/description (max 100 characters). |
| `token` | string | Yes | Your application's API token. |
| `device` | string | No | Restrict update to a specific device's widget; omit to update all widgets. |
| `percent` | integer | No | Percent/progress value (0-100 inclusive). |
| `subtext` | string | No | Second line of data (max 100 characters). |

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

### Add User to Group

**Slug:** `PUSHOVER_GROUP_ADD_USER`

Tool to add an existing Pushover user to a delivery group. Use when you need to include a user in a group by their user key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `memo` | string | No | Optional memo or note for the user (up to 200 characters). |
| `user` | string | Yes | The Pushover user key of the existing user to add. |
| `token` | string | Yes | Your Pushover application API token owning the group. |
| `device` | string | No | Device name to restrict messages for this user; leave blank to target all devices. |
| `group_key` | string | Yes | Delivery group key identifying the target group. |

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

### Create Group

**Slug:** `PUSHOVER_GROUP_CREATE`

Tool to create a new Delivery Group. Use when you need to group multiple recipients under one group key before sending notifications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The new group's name. |
| `token` | string | Yes | Your Pushover application API token. |

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

### Disable Group User

**Slug:** `PUSHOVER_GROUP_DISABLE_USER`

Tool to temporarily disable deliveries to a user or specific device within a Pushover group. Use when suspending notifications for a user (or device) in an active group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | string | Yes | The Pushover user key to disable within the group. |
| `token` | string | Yes | Your Pushover application API token. |
| `device` | string | No | Specific device name for the user's membership; if omitted, disables all devices for that user. |
| `group_key` | string | Yes | The delivery group's key (path parameter). |

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

### Group Enable User

**Slug:** `PUSHOVER_GROUP_ENABLE_USER`

Tool to re-enable deliveries to a previously disabled user (or specific device) within a Pushover group. Use after disabling a user's or device's notifications to restore delivery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | string | Yes | Pushover user key to re-enable deliveries for. |
| `token` | string | Yes | Your application API token associated with the group. |
| `device` | string | No | Optional device name to match; if omitted, all disabled memberships for the user are re-enabled. |
| `group_key` | string | Yes | Unique key for the Pushover delivery group. |

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

**Slug:** `PUSHOVER_GROUP_GET`

Tool to retrieve details for a Delivery Group. Use when you need to fetch a group's name and member list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | Your Pushover application API token owning the group. |
| `group_key` | string | Yes | Delivery group key identifying the target group. |

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

### List Delivery Groups

**Slug:** `PUSHOVER_GROUP_LIST`

Tool to list all Delivery Groups. Use when you need to retrieve your account's delivery groups after obtaining a valid API token.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | Your Pushover application API token. |

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

### Remove User from Group

**Slug:** `PUSHOVER_GROUP_REMOVE_USER`

Tool to remove a user (or optionally a specific device) from a Pushover delivery group. Use when you need to revoke a user's membership so they stop receiving group notifications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | string | Yes | The Pushover user key to remove from the group. |
| `token` | string | Yes | Your Pushover application API token. |
| `device` | string | No | Specific device name for the user's membership; if omitted, removes the user from all devices. |
| `group_key` | string | Yes | The delivery group's key (path parameter). |

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

### Rename Delivery Group

**Slug:** `PUSHOVER_GROUP_RENAME`

Tool to rename an existing Delivery Group. Use after confirming the group_key to update a group's name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The new name to assign to the delivery group. Only one group name may exist per account. |
| `token` | string | Yes | Your Pushover application API token for authentication. |
| `group_key` | string | Yes | The unique key of the delivery group to rename (used in the URL path). |

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

### Assign License

**Slug:** `PUSHOVER_LICENSE_ASSIGN`

Tool to assign a pre-paid license credit to a Pushover user by key or email. Use when you need to allocate a license and optionally restrict to a specific platform.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `os` | string | No | Platform to restrict license to: 'Android', 'iOS', or 'Desktop'; leave blank to assign for first installed platform. |
| `user` | string | No | Pushover user key; required if email is not supplied. |
| `email` | string | No | User's e-mail address; required if user is not supplied. |
| `token` | string | Yes | Your application's API token. |

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

### Check License Credits

**Slug:** `PUSHOVER_LICENSE_CHECK_CREDITS`

Tool to retrieve remaining license credits for a Pushover application. Use when monitoring your licensing quota before assigning new licenses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | Your Pushover application API token for licensing API. |

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

**Slug:** `PUSHOVER_SEND_MESSAGE`

Tool to send a push notification with optional title, URL, priority, sound, attachments, and filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ttl` | integer | No | Time to live in seconds; ignored for emergency priority. |
| `url` | string | No | Supplementary URL shown with the message. |
| `html` | integer | No | Set to 1 to enable HTML parsing; mutually exclusive with monospace. |
| `tags` | string | No | (Emergency only) comma-separated tags stored with the receipt. |
| `user` | string | Yes | User or group key(s). Up to 50 comma-separated alphanumeric keys (each 30 chars). |
| `retry` | integer | No | (Emergency only) seconds between retries; minimum 30. |
| `sound` | string | No | Name of a supported sound (blank for user default). |
| `title` | string | No | Message title (max 250 chars). Defaults to the application name. |
| `token` | string | Yes | Your Pushover application API token (30 alphanumeric characters). |
| `device` | string | No | One device name or comma-separated names; ignored for multiple users or non-team groups. |
| `expire` | integer | No | (Emergency only) total seconds to keep retrying; max 10800. |
| `message` | string | Yes | Notification body text (up to 1024 UTF-8 characters). |
| `callback` | string | No | (Emergency only) URL called when the user acknowledges. |
| `priority` | integer | No | Message priority: -2 (lowest), -1 (low), 0 (normal), 1 (high), 2 (emergency). |
| `monospace` | integer | No | Set to 1 to use monospace font; mutually exclusive with html. |
| `timestamp` | integer | No | Unix epoch time to display instead of current time. |
| `url_title` | string | No | Title for the supplementary URL. |
| `attachment` | object | No | Binary image attachment (max 5MB). |
| `attachment_type` | string | No | MIME type of the base64 attachment (e.g., 'image/jpeg'). |
| `attachment_base64` | string | No | Base64-encoded image data; requires 'attachment_type'. |

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

### Store Team API Token

**Slug:** `PUSHOVER_STORE_TEAM_API_TOKEN`

Tool to securely store a Pushover for Teams API token. Use after obtaining a team API token to enable subsequent Teams actions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | Pushover for Teams API token to store for future actions. |

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

### Subscription Flow

**Slug:** `PUSHOVER_SUBSCRIPTION_FLOW`

Tool to validate and return a Pushover subscription code. Use when Pushover does not support programmatic subscription creation and you need to confirm your code before redirecting users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscription_code` | string | Yes | The subscription code obtained from Pushover's web-based subscription flow. Must be URL-safe (no whitespace). |

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

### Add Team User

**Slug:** `PUSHOVER_TEAMS_ADD_USER`

Tool to add a user to a Pushover for Teams organization. Use when inviting a user with optional admin rights, instant login link, or custom delivery group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | User’s full name |
| `admin` | string | No | 'true' to add the user as a team administrator |
| `email` | string | Yes | User’s email address |
| `group` | string | No | Delivery Group name; if it doesn’t exist, it will be created; default is the auto-updating Team Delivery Group |
| `token` | string | Yes | Team API token (not application token) |
| `instant` | string | No | 'true' to include an Instant Login link in the welcome e-mail (valid 7 days) |
| `password` | string | No | Explicit password to assign; if omitted or blank, a random password will be generated and e-mailed |

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

### Remove User from Team

**Slug:** `PUSHOVER_TEAMS_REMOVE_USER`

Tool to remove a user from a Pushover for Teams organization. Use when you need to revoke a user's access after confirming their email should be removed from the team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | E-mail address of the user to remove from the team. |
| `token` | string | Yes | Team API token (not an application token). |

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

### Validate User or Group

**Slug:** `PUSHOVER_VALIDATE_USER_OR_GROUP`

Tool to validate a Pushover user or group key for deliverability. Use before sending notifications to ensure the key (and optional device) is valid and has active devices.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | string | Yes | The user's or group's identifier (key) to validate. |
| `token` | string | Yes | Your Pushover application API token. |
| `device` | string | No | Device name to validate against that user; if omitted, validation succeeds when at least one active device exists. |

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