API tokens are free and can be registered through our website.

Please note that while API tokens can be used to send to multiple users, any API tokens you register should be protected and not disclosed to any other users or given to any 3rd party services.

To quickly get started sending Pushover messages with a wide variety of programming languages, we have some sample code as well as a number of 3rd party libraries written and maintained by Pushover users.

In all of these examples, replace USER_KEY with your Pushover User Key (which can be found on your dashboard) or that of the user/group to which you are sending, and API_TOKEN with your application's API Token.  If you don't already have an application API Token, you can create one for free.

Note: if your language of choice is not listed here, try browsing all GitHub libraries tagged "pushover".

C

The 3rd party cpushover library written by Christian Bjartli is available. This library uses libcurl.

C#/.NET

Using the built-in HttpClient class:

var parameters = new Dictionary<string, string> {
    ["token"] = "APP_TOKEN",
    ["user"] = "USER_KEY",
    ["message"] = "hello world"
};
using var client = new HttpClient();
var response = await client.PostAsync("https://api.pushover.net/1/messages.json", new
FormUrlEncodedContent(parameters));

Alternatively, the 3rd party Pushover.NET package written by Matthew Sawyer, and the Pushover-API package written by Michal Altair Valášek are available.

C++ / ESP32

The 3rd party PushoverESP32 library written by Bruno Joyal is available.

Go

The 3rd party gopush package written by Kyle Isom is available, as well as the pushover package written by Grégoire Delattre.

Haskell

The 3rd party hPushover package written by Wander Hillen is available.

Java

The 3rd party pushover4j package written by Sean Scanlon is available.

The 3rd party Pushover API Micronaut Java library written by Sergio del Amo is also available.

Lua

The 3rd party pushover-lua package written by Sven Andersson is available.

Node

The 3rd party node-pushover package written by Sam Decrock, the pushover-notifications package written by Aaron Bieber, and the chump package written by Michael Squires are all available via npm.

Perl

Using the CPAN module LWP::UserAgent may also require the Mozilla::CA module installed for proper TLS validation:

use LWP::UserAgent;

LWP::UserAgent->new()->post(
  "https://api.pushover.net/1/messages.json", [
  "token" => "APP_TOKEN",
  "user" => "USER_KEY",
  "message" => "hello world",
]);

Alternatively, the 3rd party WebService::Pushover Perl module written by Steve Huff is available in CPAN.

PHP

Using the built-in cURL module:

<?php
curl_setopt_array($ch = curl_init(), array(
  CURLOPT_URL => "https://api.pushover.net/1/messages.json",
  CURLOPT_POSTFIELDS => array(
    "token" => "APP_TOKEN",
    "user" => "USER_KEY",
    "message" => "hello world",
  ),
  CURLOPT_SAFE_UPLOAD => true,
  CURLOPT_RETURNTRANSFER => true,
));
curl_exec($ch);
curl_close($ch);
?>

Alternatively, there are a number of 3rd party PHP libraries available:

• php-pushover PHP class written by Chris Schalenborgh
• Pushy PHP package written by Michael Squires
• Pushover for PHP package written by Leonardo C. Teixeira
• Laravel-pushover package for the Laravel framework written by Dyaa Eldin Moustafa
• laravel-pushover package for the Laravel framework written by Edward Karlsson
• codeigniter4-pushover package for the CodeIgniter 4 framework written by Tatter Software
• pushover-php package written by Serhiy Lunak

PHP with Image Attachment

Please see our API documentation for information about attachments such as file size limits.

The cURL module can be used, though the curl_file_create function requires at least PHP 5.5.

<?php
curl_setopt_array($ch = curl_init(), array(
  CURLOPT_URL => "https://api.pushover.net/1/messages.json",
  CURLOPT_POSTFIELDS => array(
    "token" => "APP_TOKEN",
    "user" => "USER_KEY",
    "message" => "hello world",
    "attachment" => curl_file_create("image.jpg", "image/jpeg"),
  ),
  CURLOPT_SAFE_UPLOAD => true,
  CURLOPT_RETURNTRANSFER => true,
));
curl_exec($ch);
curl_close($ch);
?>

Python

The standard httplib and urllib libraries can be used:

import httplib, urllib
conn = httplib.HTTPSConnection("api.pushover.net:443")
conn.request("POST", "/1/messages.json",
  urllib.urlencode({
    "token": "APP_TOKEN",
    "user": "USER_KEY",
    "message": "hello world",
  }), { "Content-type": "application/x-www-form-urlencoded" })
conn.getresponse()

 For Python 3, httplib has been replaced with http.client and urlencode has moved to urllib.parse.

import http.client, urllib
conn = http.client.HTTPSConnection("api.pushover.net:443")
conn.request("POST", "/1/messages.json",
  urllib.parse.urlencode({
    "token": "APP_TOKEN",
    "user": "USER_KEY",
    "message": "hello world",
  }), { "Content-type": "application/x-www-form-urlencoded" })
conn.getresponse()

 Alternatively, a number of 3rd party packages are available:  pushnotify package written by Jeffrey Goettsch, pushover Python 3 package written by Wyatt Johnson, Chump Python package written by Karan Lyons, and python-pushover Python package written by Thibaut Horel.

Python with Image Attachment

To send an image attachment, the 3rd party Requests library can be used. For example, to send the file "your_image.jpg":

import requests
r = requests.post("https://api.pushover.net/1/messages.json", data = {
  "token": "APP_TOKEN",
  "user": "USER_KEY",
  "message": "hello world"
},
files = {
  "attachment": ("image.jpg", open("your_image.jpg", "rb"), "image/jpeg")
})
print(r.text)

R

The 3rd party pushoverr R module written by Brian Connelly is available.

Ruby

The standard Net::HTTPS library can be used:

require "net/https"

url = URI.parse("https://api.pushover.net/1/messages.json")
req = Net::HTTP::Post.new(url.path)
req.set_form_data({
  :token => "APP_TOKEN",
  :user => "USER_KEY",
  :message => "hello world",
})
res = Net::HTTP.new(url.host, url.port)
res.use_ssl = true
res.verify_mode = OpenSSL::SSL::VERIFY_PEER
res.start {|http| http.request(req) }

Alternatively, the 3rd party rushover Ruby module written by Brendon Murphy is available through Ruby Gems.

Rust

The 3rd party po Rust library written by Jordan Mulcahey is available.

Swift

The 3rd party pushover Swift library written by Kilian Koeltzsch is available.

Visual Basic for Applications (VBA)

The 3rd party pushover-vba module written by Mauricio Arieira is available.

Unix command line

The curl program may be used from the command line or integrated into shell scripts:

curl -s \
  --form-string "token=APP_TOKEN" \
  --form-string "user=USER_KEY" \
  --form-string "message=hello world" \
  https://api.pushover.net/1/messages.json

Unix command line with Image Attachment

Please see our API documentation for information about attachments such as file size limits.

curl can easily upload files as parameters by specifying a parameter such as "attachment=@filename.jpg" as the value, which will read filename.jpg on your computer and send it as the attachment parameter, complete with the necessary meta-data such as its Content-Type and name.

Note: because curl does file uploading automatically with the -F option, we strongly recommend using --form-string for all other parameters to avoid being tricked into sending a file from your computer as parameter data if you are passing message data from external sources.

curl -s \
  --form-string "token=APP_TOKEN" \
  --form-string "user=USER_KEY" \
  --form-string "message=here is an image attachment" \
  -F "attachment=@image.jpg" \
  https://api.pushover.net/1/messages.json

Windows command line

The curl program may be used (Download a Win32 build with TLS support):

curl -s \
  --cacert curl-ca-bundle.crt \
  --form-string "token=APP_TOKEN" \
  --form-string "user=USER_KEY" \
  --form-string "message=hello world" \
  https://api.pushover.net/1/messages.json

 Alternatively, PowerShell can be used. For PowerShell v3, using the new Invoke-RestMethod cmdlet, courtesy of Hal Rottenberg:

$uri = "https://api.pushover.net/1/messages.json"
$parameters = @{
  token = "APP_TOKEN"
  user = "USER_KEY"
  message = "hello world"
}
$parameters | Invoke-RestMethod -Uri $uri -Method Post

 Or for older versions:

$parameters = New-Object System.Collections.Specialized.NameValueCollection
$parameters.Add("token", "APP_TOKEN")
$parameters.Add("user", "USER_KEY")
$parameters.Add("message", "hello world")
$client = New-Object System.Net.WebClient
$client.UploadValues("https://api.pushover.net/1/messages.json", $parameters)

 The 3rd party PowerShell modules PowerShellPushOver written by Kieran Jacobsen, and PushoverForPS written by Chris Carter are also available.

Note: for companies and organizations that require centralized management of multiple accounts, please see our Pushover for Teams service which greatly simplifies sending messages to multiple users.

Creating a Delivery Group

To create a Delivery Group, login to your Dashboard and click Create a Group and then list each user's Pushover User Key:

Each user can find their Pushover User Key by logging into their Dashboard:

Note: this is just an example User Key and is not your actual key

Note that it is not possible to send to users just based on their e-mail address for security and privacy concerns.  You'll need to collect their actual Pushover User Key.

Once you have created your Delivery Group, you'll be given a new Group Key.  This Group Key can be used in place of your individual Pushover User Key in any software that supports sending through Pushover.  Any messages sent to the Group Key will be broadcast to all members in the Group.

Adding Many Users to a Group

If you plan on sending Pushover messages to a large group of users where collecting User Keys from them would be tedious, check out our Web-Based Subscriptions.  This mechanism gives you a URL you can direct users to which allows them to subscribe and later unsubscribe from your Delivery Group on their own, without you having to manage your Delivery Group.

Licensing

When multiple Pushover users share the same iTunes or Google Play billing account, only one user has to make an in-app purchase.  The purchase can be validated on multiple Pushover accounts at the same time.

By creating a Group-based Subscription, users can visit a URL that we create for your application and choose to subscribe to notifications from your application.  Once subscribed, the user will be added to a Delivery Group with a single-use User Key that is deleted as soon as the user unsubscribes from your application.  The user's actual User Key remains private, and no information about the user is shared with you.

If you need more control over the subscription process, such as tying a subscribed user to an account on your server, or to be able to send custom notifications to each user, you will need to instead create a Web-based Subscription.

Creating a Subscription

To get started, find or create an application on your Dashboard under Your Applications.  Under the API Token/Key section at the top, click on Edit Subscription Settings.

Next, add a description, author, and optional informational URL.  These will be shown to Pushover users when subscribing to your application.  For the Subscription Type, choose Group, and choose an existing Delivery Group from the list or Create a New Group.  The group name is not shown to users.

Click Create Subscription Code and you'll be returned to your application's information page.  At the top, you will now see a URL for your subscription:

This URL can be given out to your users by e-mail, chat, added to a web page, or any other mechanism appropriate for your users.  When anyone visits that URL, they will be prompted to subscribe to your group and the user can optionally choose a specific device to receive your notifications and a sound.  Any custom sounds added to your application be available for users to choose from, in addition to any custom sounds the user has uploaded.

Once a user is subscribed, they will be automatically added to the Delivery Group you chose earlier with a one-time, private user key.

Sending Messages

To send a message to all subscribed users in your group, just use the Group Key assigned to the group in place of a User Key in any software that supports Pushover.  You can find this Group Key on the Delivery Group's page from your Dashboard under Your Delivery Groups.

You can also send a message from your dashboard by choosing your application as the Send As option, and your Delivery Group as the To Device/Group:

One application assigned to a Team can send up to 25,000 messages per month for free. All other applications can send the usual 10,000 amount for free.

To send more than the free amount of messages per month, upgrade packages are available.

For per-message size limitations, please see the limitations section of our API documentation.

For high-volume applications that need to send more than 10,000 messages per month, additional capacity can be purchased from our website (10,000 for $50.00 USD, 25,000 for $115.00 USD, 50,000 for $200.00 USD, 100,000 for $300.00 USD, 500,000 for $1000.00 USD). Once an application uses its free allowance, subsequent messages will start deducting from its purchased reserve until the first of the next month. An application's purchased reserve will remain available until it has been completely used. Upgraded capacity is not transferable or refundable.

Additional message capacity can be purchased instantly through our website by viewing your specific application:

Then click "Purchase Additional Message Capacity" (you may not see this option on applications that have not been used):

You'll have the option to make a single upgrade purchase or keep the credit card on file for automatic upgrading whenever your message capacity gets low.

When using curl in shell scripts, you may find it easiest to just insert literal line breaks in your file:

curl -s \
  --form-string "token=APP_TOKEN" \
  --form-string "user=USER_KEY" \
  --form-string "message=this is a

message with a line break" \
  https://api.pushover.net/1/messages.json

To get your application listed, it must follow these guidelines:

• The resource must be publicly available (i.e., not an internal company application). You may charge money for the app, plugin, or service, but you cannot charge extra for Pushover functionality.
• For externally hosted services, you must use one API token per service/application and you are responsible for purchasing additional capacity as needed. You may not register multiple API token to get around our message limits and you may not request or host API tokens registered by end-users.
• Your Pushover integration must conform to our Pushover Logos and Usage guidelines.
• Your Pushover integration must be mentioned somewhere that is accessible to the public, such as a webpage or application documentation that we can point to. One should not have to login or pay for an application to verify that it includes Pushover support.

If your application conforms to these guidelines, you are eligible to have it listed on our Featured Public Applications page. To get started:

1. Edit your previously registered application on our website and verify that the description, URL, and icon are set properly. Once an application has been made public, these settings cannot be changed through our website.
2. Send us a support message and include:
   1. The application's API token
   2. The name of the author we should list on our apps page and an optional URL for the author (if separate from the URL to the application), and
   3. The URL to the webpage or application documentation that describes how the application integrates with Pushover.

Once we have verified your Pushover integration, we will add it to our apps page and contact you.

For those distributing software that is installed and managed by your end-users, such as libraries and open source projects that use Pushover's API, each user must register their own application and then enter that unique API token in their copy of your software. This way each user will get their own monthly quota of messages without being affected by other users. For popular applications listed on our Featured Public Applications page, we can enable a special cloning URL that you can direct users to that will simplify this registration process for them.

Please note, this does not apply to SaaS/hosted applications.  If you are managing a service or application for multiple users, you may only use one API token and you are not permitted to store or use API tokens registered by end-users.

For example, users setting up irssi can be directed to https://pushover.net/apps/clone/irssi which will automatically clone the app's icon, description, and URL. The user just has to confirm the terms of service, click a button, and they can easily get their own API token to copy and paste into the irssi plugin configuration. For developers looking to get this functionality with their apps, please register your own application and set a proper description and icon, and then contact us with the details of what your application does, how it integrates with Pushover, and the API token you have registered that you would like to be made cloneable.

If you are providing a free service that uses Pushover where you are still in control of your API token (such as a website or server-side app that you run), contact us to inquire about getting a free upgrade of your permitted monthly notifications.