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

# Pushover

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

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

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

## Tools

> [accordion] 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
>
> **token** `string` *required*
>
> Your Pushover application API token
>
> **receipt** `string` *required*
>
> The receipt ID returned when the message was first sent
>
> #### 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] 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
>
> **tag** `string` *required*
>
> Tag assigned to messages when originally sent; identifies which receipts to cancel.
>
> **token** `string` *required*
>
> Application API token for authentication.
>
> #### 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] 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
>
> **secret** `string` *required*
>
> User session secret obtained at login; required for Open Client actions.
>
> **message** `integer` *required*
>
> Highest message ID previously seen; all messages up to and including this ID are deleted.
>
> **device\_id** `string` *required*
>
> The unique device ID returned during Device Registration.
>
> #### 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] 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
>
> **secret** `string` *required*
>
> User session secret obtained after login, required to authenticate the client.
>
> **device\_id** `string` *required*
>
> Unique identifier of the registered device to fetch messages for.
>
> #### 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] 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
>
> **email** `string` *required*
>
> Pushover account e-mail; case-sensitive
>
> **twofa** `string`
>
> Two-factor authentication code; include only after prior HTTP 412 response
>
> **password** `string` *required*
>
> Pushover account password; case-sensitive
>
> #### 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] Client Realtime WebSocket Connection
>
> **Slug:** `PUSHOVER_CLIENT_REALTIME_WEBSOCKET`
>
> Connect to the Pushover real-time WebSocket with a device ID and session secret, collect notification events, and return them when the connection closes or a terminating event occurs.
>
> #### Input Parameters
>
> **secret** `string` *required*
>
> Your user session secret for login
>
> **timeout** `integer`
>
> Maximum time in seconds to listen for events before closing
>
> **device\_id** `string` *required*
>
> Your Pushover client device ID for login
>
> #### 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] 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
>
> **os** `string`
>
> Must be 'O' (capital letter O) for Open Client.
>
> **name** `string` *required*
>
> Short device name; allowed characters are letters, numbers, underscore, hyphen; max length 25.
>
> **secret** `string` *required*
>
> User session secret obtained from users/login; must be included.
>
> #### 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 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
>
> **icon** `string` *required*
>
> Icon identifier string (from message object's 'icon' field).
>
> #### 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 App Limits
>
> **Slug:** `PUSHOVER_GET_APP_LIMITS`
>
> Retrieve the current monthly message limit, remaining messages, and reset time using a Pushover application token. The quota is shared across the applications belonging to the user or team account.
>
> #### Input Parameters
>
> **token** `string` *required*
>
> Your Pushover application API token.
>
> #### 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 Application Token
>
> **Slug:** `PUSHOVER_GET_APP_TOKEN`
>
> Return a Pushover application API token from the supplied token, available metadata, or environment variables. The token is returned in the response.
>
> #### Input Parameters
>
> **token** `string`
>
> Optional override for the Pushover application API token. If provided, this value will be returned.
>
> #### 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 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
>
> **token** `string` *required*
>
> Your application API token for Pushover.
>
> **receipt** `string` *required*
>
> 30-character alphanumeric receipt returned when sending an emergency-priority message.
>
> #### 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 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
>
> **token** `string`
>
> Optional override for the Pushover team API token. If provided, this value will be returned.
>
> #### 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] 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
>
> **text** `string`
>
> Main line of data (max 100 characters).
>
> **user** `string` *required*
>
> The recipient user's Pushover user key.
>
> **count** `integer`
>
> Count value for smaller screens; may be negative.
>
> **title** `string`
>
> Short label/description (max 100 characters).
>
> **token** `string` *required*
>
> Your application's API token.
>
> **device** `string`
>
> Restrict update to a specific device's widget; omit to update all widgets.
>
> **percent** `integer`
>
> Percent/progress value (0-100 inclusive).
>
> **subtext** `string`
>
> Second line of data (max 100 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] 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
>
> **memo** `string`
>
> Optional memo or note for the user (up to 200 characters).
>
> **user** `string` *required*
>
> The Pushover user key of the existing user to add.
>
> **token** `string` *required*
>
> Your Pushover application API token owning the group.
>
> **device** `string`
>
> Device name to restrict messages for this user; leave blank to target all devices.
>
> **group\_key** `string` *required*
>
> Delivery group key identifying the target group.
>
> #### 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 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
>
> **name** `string` *required*
>
> The new group's name.
>
> **token** `string` *required*
>
> Your Pushover application API token.
>
> #### 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] 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
>
> **user** `string` *required*
>
> The Pushover user key to disable within the group.
>
> **token** `string` *required*
>
> Your Pushover application API token.
>
> **device** `string`
>
> Specific device name for the user's membership; if omitted, disables all devices for that user.
>
> **group\_key** `string` *required*
>
> The delivery group's key (path parameter).
>
> #### 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] 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
>
> **user** `string` *required*
>
> Pushover user key to re-enable deliveries for.
>
> **token** `string` *required*
>
> Your application API token associated with the group.
>
> **device** `string`
>
> Optional device name to match; if omitted, all disabled memberships for the user are re-enabled.
>
> **group\_key** `string` *required*
>
> Unique key for the Pushover delivery group.
>
> #### 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 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
>
> **token** `string` *required*
>
> Your Pushover application API token owning the group.
>
> **group\_key** `string` *required*
>
> Delivery group key identifying the target group.
>
> #### 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 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
>
> **token** `string` *required*
>
> Your Pushover application API token.
>
> #### 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 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
>
> **user** `string` *required*
>
> The Pushover user key to remove from the group.
>
> **token** `string` *required*
>
> Your Pushover application API token.
>
> **device** `string`
>
> Specific device name for the user's membership; if omitted, removes the user from all devices.
>
> **group\_key** `string` *required*
>
> The delivery group's key (path parameter).
>
> #### 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] 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
>
> **name** `string` *required*
>
> The new name to assign to the delivery group. Only one group name may exist per account.
>
> **token** `string` *required*
>
> Your Pushover application API token for authentication.
>
> **group\_key** `string` *required*
>
> The unique key of the delivery group to rename (used in the URL path).
>
> #### 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] 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
>
> **os** `string`
>
> Platform to restrict license to: 'Android', 'iOS', or 'Desktop'; leave blank to assign for first installed platform.
>
> **user** `string`
>
> Pushover user key; required if email is not supplied.
>
> **email** `string`
>
> User's e-mail address; required if user is not supplied.
>
> **token** `string` *required*
>
> Your application's API token.
>
> #### 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] 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
>
> **token** `string` *required*
>
> Your Pushover application API token for licensing API.
>
> #### 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 Message
>
> **Slug:** `PUSHOVER_SEND_MESSAGE`
>
> Send a Pushover push notification with optional title, URL, priority, sound, device targeting, and attachments.
>
> #### Input Parameters
>
> **ttl** `integer`
>
> Time to live in seconds; ignored for emergency priority.
>
> **url** `string`
>
> Supplementary URL shown with the message.
>
> **html** `integer`
>
> Set to 1 to enable HTML parsing; mutually exclusive with monospace.
>
> **tags** `string`
>
> (Emergency only) comma-separated tags stored with the receipt.
>
> **user** `string` *required*
>
> User or group key(s). Up to 50 comma-separated alphanumeric keys (each 30 chars).
>
> **retry** `integer`
>
> (Emergency only) seconds between retries; minimum 30.
>
> **sound** `string`
>
> Name of a supported sound (blank for user default).
>
> **title** `string`
>
> Message title (max 250 chars). Defaults to the application name.
>
> **token** `string` *required*
>
> Your Pushover application API token (30 alphanumeric characters).
>
> **device** `string`
>
> One device name or comma-separated names; ignored for multiple users or non-team groups.
>
> **expire** `integer`
>
> (Emergency only) total seconds to keep retrying; max 10800.
>
> **message** `string` *required*
>
> Notification body text (up to 1024 UTF-8 characters).
>
> **callback** `string`
>
> (Emergency only) URL called when the user acknowledges.
>
> **priority** `integer`
>
> Message priority: -2 (lowest), -1 (low), 0 (normal), 1 (high), 2 (emergency).
>
> **monospace** `integer`
>
> Set to 1 to use monospace font; mutually exclusive with html.
>
> **timestamp** `integer`
>
> Unix epoch time to display instead of current time.
>
> **url\_title** `string`
>
> Title for the supplementary URL.
>
> **attachment** `object`
>
> Binary image attachment (max 5MB).
>
> **attachment\_type** `string`
>
> MIME type of the base64 attachment (e.g., 'image/jpeg').
>
> **attachment\_base64** `string`
>
> Base64-encoded image data; requires 'attachment\_type'.
>
> #### 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] Store Team API Token
>
> **Slug:** `PUSHOVER_STORE_TEAM_API_TOKEN`
>
> Place a Pushover for Teams API token in the current execution metadata and return a success flag.
>
> #### Input Parameters
>
> **token** `string` *required*
>
> Pushover for Teams API token to store for future actions.
>
> #### 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] Subscription Flow
>
> **Slug:** `PUSHOVER_SUBSCRIPTION_FLOW`
>
> Check that a Pushover subscription code is nonempty and contains no whitespace, then return it.
>
> #### Input Parameters
>
> **subscription\_code** `string` *required*
>
> The subscription code obtained from Pushover's web-based subscription flow. Must be URL-safe (no whitespace).
>
> #### 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] 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
>
> **name** `string`
>
> User’s full name
>
> **admin** `string`
>
> 'true' to add the user as a team administrator
>
> **email** `string` *required*
>
> User’s email address
>
> **group** `string`
>
> Delivery Group name; if it doesn’t exist, it will be created; default is the auto-updating Team Delivery Group
>
> **token** `string` *required*
>
> Team API token (not application token)
>
> **instant** `string`
>
> 'true' to include an Instant Login link in the welcome e-mail (valid 7 days)
>
> **password** `string`
>
> Explicit password to assign; if omitted or blank, a random password will be generated and e-mailed
>
> #### 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 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
>
> **email** `string` *required*
>
> E-mail address of the user to remove from the team.
>
> **token** `string` *required*
>
> Team API token (not an application token).
>
> #### 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] 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
>
> **user** `string` *required*
>
> The user's or group's identifier (key) to validate.
>
> **token** `string` *required*
>
> Your Pushover application API token.
>
> **device** `string`
>
> Device name to validate against that user; if omitted, validation succeeds when at least one active device exists.
>
> #### 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
