Notifications

Pushover

Learn how to use Pushover with Composio

Overview

SLUG: PUSHOVER

Description

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

Authentication Details

generic_api_key
stringRequired

Connecting to Pushover

Create an auth config

Use the dashboard to create an auth config for the Pushover toolkit. This allows you to connect multiple Pushover accounts to Composio for agents to use.

1

Select App

Navigate to Pushover.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Pushover Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4pushover_auth_config_id = "ac_YOUR_PUSHOVER_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Pushover for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, pushover_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Pushover toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["PUSHOVER"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Cancel Receipt Retries

Description

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.

Action Parameters

receipt
stringRequired
token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Cancel Retries by Tag

Description

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.

Action Parameters

tag
stringRequired
token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Client Acknowledge Delete Up To ID

Description

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.

Action Parameters

device_id
stringRequired
message
integerRequired
secret
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Fetch Pending Messages

Description

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

Action Parameters

device_id
stringRequired
secret
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Pushover Client Login

Description

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.

Action Parameters

email
stringRequired
password
stringRequired
twofa
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Client Realtime WebSocket Connection

Description

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

Action Parameters

device_id
stringRequired
secret
stringRequired
timeout
integerDefaults to 60

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Register Open Client Device

Description

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

Action Parameters

name
stringRequired
os
stringDefaults to O
secret
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Application Icon Image

Description

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

Action Parameters

icon
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get App Limits

Description

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.

Action Parameters

token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Application Token

Description

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

Action Parameters

token
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Receipt Status

Description

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.

Action Parameters

receipt
stringRequired
token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Team API Token

Description

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

Action Parameters

token
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Glances Update

Description

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.

Action Parameters

count
integer
device
string
percent
integer
subtext
string
text
string
title
string
token
stringRequired
user
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add User to Group

Description

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.

Action Parameters

device
string
group_key
stringRequired
memo
string
token
stringRequired
user
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Group

Description

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

Action Parameters

name
stringRequired
token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Disable Group User

Description

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.

Action Parameters

device
string
group_key
stringRequired
token
stringRequired
user
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Group Enable User

Description

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.

Action Parameters

device
string
group_key
stringRequired
token
stringRequired
user
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Group Details

Description

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

Action Parameters

group_key
stringRequired
token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Delivery Groups

Description

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

Action Parameters

token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove User from Group

Description

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.

Action Parameters

device
string
group_key
stringRequired
token
stringRequired
user
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Rename Delivery Group

Description

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

Action Parameters

group_key
stringRequired
name
stringRequired
token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Assign License

Description

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.

Action Parameters

email
string
os
string
token
stringRequired
user
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Check License Credits

Description

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

Action Parameters

token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Send Message

Description

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

Action Parameters

attachment
object
attachment_base64
string
attachment_type
string
callback
string
device
string
expire
integer
html
integer
message
stringRequired
monospace
integer
priority
integer
retry
integer
sound
string
tags
string
timestamp
integer
title
string
token
stringRequired
ttl
integer
url
string
url_title
string
user
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Store Team API Token

Description

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

Action Parameters

token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Subscription Flow

Description

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.

Action Parameters

subscription_code
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add Team User

Description

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.

Action Parameters

admin
string
email
stringRequired
group
string
instant
string
name
string
password
string
token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove User from Team

Description

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.

Action Parameters

email
stringRequired
token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Validate User or Group

Description

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.

Action Parameters

device
string
token
stringRequired
user
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired