Skip to main content
Pushover logo
  • Category: notifications
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 29
  • Triggers: 0
  • Slug: PUSHOVER
  • Version: 20261101_00

Tools

Slug: PUSHOVER_CANCEL_RECEIPT_RETRIESTool 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

string
required
Your Pushover application API token
string
required
The receipt ID returned when the message was first sent

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: PUSHOVER_CANCEL_RETRIES_BY_TAGTool 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

string
required
Tag assigned to messages when originally sent; identifies which receipts to cancel.
string
required
Application API token for authentication.

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: PUSHOVER_CLIENT_ACK_DELETE_UP_TO_IDTool 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

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

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: PUSHOVER_CLIENT_FETCH_MESSAGESTool to download pending messages for a registered device. Use after device registration to retrieve messages queued server-side.

Input Parameters

string
required
User session secret obtained after login, required to authenticate the client.
string
required
Unique identifier of the registered device to fetch messages for.

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: PUSHOVER_CLIENT_LOGINTool 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

string
required
Pushover account e-mail; case-sensitive
string
Two-factor authentication code; include only after prior HTTP 412 response
string
required
Pushover account password; case-sensitive

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: PUSHOVER_CLIENT_REALTIME_WEBSOCKETConnect 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

string
required
Your user session secret for login
integer
Maximum time in seconds to listen for events before closing
string
required
Your Pushover client device ID for login

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: PUSHOVER_CLIENT_REGISTER_DEVICETool to register an Open Client desktop device. Use when you have a session secret from users/login to obtain a device ID.

Input Parameters

string
Must be ‘O’ (capital letter O) for Open Client.
string
required
Short device name; allowed characters are letters, numbers, underscore, hyphen; max length 25.
string
required
User session secret obtained from users/login; must be included.

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: PUSHOVER_GET_APP_ICON_IMAGETool to fetch an application icon PNG by icon identifier. Use when you need to retrieve and cache the Pushover app icon image.

Input Parameters

string
required
Icon identifier string (from message object’s ‘icon’ field).

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: PUSHOVER_GET_APP_LIMITSRetrieve 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

string
required
Your Pushover application API token.

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: PUSHOVER_GET_APP_TOKENReturn a Pushover application API token from the supplied token, available metadata, or environment variables. The token is returned in the response.

Input Parameters

string
Optional override for the Pushover application API token. If provided, this value will be returned.

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: PUSHOVER_GET_RECEIPT_STATUSTool 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

string
required
Your application API token for Pushover.
string
required
30-character alphanumeric receipt returned when sending an emergency-priority message.

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: PUSHOVER_GET_TEAM_API_TOKENTool to fetch stored Pushover for Teams API token. Use when supplying team credentials to other Pushover Teams actions securely.

Input Parameters

string
Optional override for the Pushover team API token. If provided, this value will be returned.

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: PUSHOVER_GLANCES_UPDATETool 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

string
Main line of data (max 100 characters).
string
required
The recipient user’s Pushover user key.
integer
Count value for smaller screens; may be negative.
string
Short label/description (max 100 characters).
string
required
Your application’s API token.
string
Restrict update to a specific device’s widget; omit to update all widgets.
integer
Percent/progress value (0-100 inclusive).
string
Second line of data (max 100 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: PUSHOVER_GROUP_ADD_USERTool 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

string
Optional memo or note for the user (up to 200 characters).
string
required
The Pushover user key of the existing user to add.
string
required
Your Pushover application API token owning the group.
string
Device name to restrict messages for this user; leave blank to target all devices.
string
required
Delivery group key identifying the target group.

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: PUSHOVER_GROUP_CREATETool to create a new Delivery Group. Use when you need to group multiple recipients under one group key before sending notifications.

Input Parameters

string
required
The new group’s name.
string
required
Your Pushover application API token.

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: PUSHOVER_GROUP_DISABLE_USERTool 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

string
required
The Pushover user key to disable within the group.
string
required
Your Pushover application API token.
string
Specific device name for the user’s membership; if omitted, disables all devices for that user.
string
required
The delivery group’s key (path parameter).

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: PUSHOVER_GROUP_ENABLE_USERTool 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

string
required
Pushover user key to re-enable deliveries for.
string
required
Your application API token associated with the group.
string
Optional device name to match; if omitted, all disabled memberships for the user are re-enabled.
string
required
Unique key for the Pushover delivery group.

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: PUSHOVER_GROUP_GETTool to retrieve details for a Delivery Group. Use when you need to fetch a group’s name and member list.

Input Parameters

string
required
Your Pushover application API token owning the group.
string
required
Delivery group key identifying the target group.

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: PUSHOVER_GROUP_LISTTool to list all Delivery Groups. Use when you need to retrieve your account’s delivery groups after obtaining a valid API token.

Input Parameters

string
required
Your Pushover application API token.

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: PUSHOVER_GROUP_REMOVE_USERTool 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

string
required
The Pushover user key to remove from the group.
string
required
Your Pushover application API token.
string
Specific device name for the user’s membership; if omitted, removes the user from all devices.
string
required
The delivery group’s key (path parameter).

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: PUSHOVER_GROUP_RENAMETool to rename an existing Delivery Group. Use after confirming the group_key to update a group’s name.

Input Parameters

string
required
The new name to assign to the delivery group. Only one group name may exist per account.
string
required
Your Pushover application API token for authentication.
string
required
The unique key of the delivery group to rename (used in the URL path).

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: PUSHOVER_LICENSE_ASSIGNTool 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

string
Platform to restrict license to: ‘Android’, ‘iOS’, or ‘Desktop’; leave blank to assign for first installed platform.
string
Pushover user key; required if email is not supplied.
string
User’s e-mail address; required if user is not supplied.
string
required
Your application’s API token.

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: PUSHOVER_LICENSE_CHECK_CREDITSTool to retrieve remaining license credits for a Pushover application. Use when monitoring your licensing quota before assigning new licenses.

Input Parameters

string
required
Your Pushover application API token for licensing API.

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: PUSHOVER_SEND_MESSAGESend a Pushover push notification with optional title, URL, priority, sound, device targeting, and attachments.

Input Parameters

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

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: PUSHOVER_STORE_TEAM_API_TOKENPlace a Pushover for Teams API token in the current execution metadata and return a success flag.

Input Parameters

string
required
Pushover for Teams API token to store for future actions.

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: PUSHOVER_SUBSCRIPTION_FLOWCheck that a Pushover subscription code is nonempty and contains no whitespace, then return it.

Input Parameters

string
required
The subscription code obtained from Pushover’s web-based subscription flow. Must be URL-safe (no whitespace).

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: PUSHOVER_TEAMS_ADD_USERTool 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

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

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: PUSHOVER_TEAMS_REMOVE_USERTool 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

string
required
E-mail address of the user to remove from the team.
string
required
Team API token (not an application token).

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: PUSHOVER_VALIDATE_USER_OR_GROUPTool 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

string
required
The user’s or group’s identifier (key) to validate.
string
required
Your Pushover application API token.
string
Device name to validate against that user; if omitted, validation succeeds when at least one active device exists.

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