Pushover

https://pushover.net/api
Admin
Pushover is a REST API platform for sending push notifications and messages to user devices across...
Tokens:21,503
Snippets:183
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### User Key Migration API Response Example

Source: https://pushover.net/api/subscriptions

Example of a successful response from the Pushover API when migrating a user key to a subscription key. This response includes a new subscribed_user_key to be saved.

```json
{"status":1,"subscribed_user_key":"sPfjsD2fGzEd9TR52DU31Hv4A61Vvk","request":"647d2300-702c-4b38-8b2f-d56326ae460b"}
```

--------------------------------

### Construct a URL-encoded POST request for Pushover

Source: https://pushover.net/api

Example of a standard HTTP POST request formatted as application/x-www-form-urlencoded for sending a notification.

```http
POST /1/messages.json HTTP/1.1
Host: api.pushover.net
Content-Type: application/x-www-form-urlencoded
Content-Length: 180

token=azGDORePK8gMaC0QOYAMyEEuzJnyUi&user=uQiRzpo4DXghDmr9QzzfQu27cmVRsG&device=droid4&title=Backup+finished+-+SQL1&message=Backup+of+database+%22example%22+finished+in+16+minutes.
```

--------------------------------

### Check Remaining License Credits

Source: https://pushover.net/api/licensing

Returns the current number of available license credits for an application via a GET request.

```json
{"status":1,"credits":5,"request":"142f8378-fd19-4cb7-9ea2-b18b15a07431"}
```

--------------------------------

### Show Team Information

Source: https://pushover.net/api/teams

Submit a GET request to this endpoint to retrieve information about your team, including its users. Requires your team's API token.

```http
https://api.pushover.net/1/teams.json?token=_(your team           token)_
```

--------------------------------

### Retrieve Information About a Specific Group

Source: https://pushover.net/api/groups

Submit a GET request to this endpoint to get details about a specific group, including its name and members. Replace '_YOUR_GROUP_KEY_' with the actual group key.

```http
GET https://api.pushover.net/1/groups/_YOUR_GROUP_KEY_.json?token=_YOUR_APP_TOKEN_
```

--------------------------------

### Raw multipart/form-data request structure

Source: https://pushover.net/api

Example of the raw HTTP request structure required when sending an attachment using multipart/form-data encoding.

```http
_[other HTTP headers]_
Content-Type: multipart/form-data; boundary=--abcdefg

----abcdefg
Content-Disposition: form-data; name="user"

_[ your Pushover user key ]_
----abcdefg
Content-Disposition: form-data; name="token"

_[ your Pushover API token ]_
----abcdefg
Content-Disposition: form-data; name="message"

your message here
----abcdefg
Content-Disposition: form-data; name="attachment"; filename="your_image.jpg"
Content-Type: image/jpeg

_[ raw binary data of image file here ]_
----abcdefg--
```

--------------------------------

### GET /1/teams.json

Source: https://pushover.net/api/teams

Retrieves information about the team, including a list of users and their device details.

```APIDOC
## GET /1/teams.json

### Description
Retrieves your Team's information including users and their associated devices.

### Method
GET

### Endpoint
https://api.pushover.net/1/teams.json

### Parameters
#### Query Parameters
- **token** (string) - Required - Your team's API token.

### Response
#### Success Response (200)
- **status** (integer) - Status code (1 for success).
- **request** (string) - Request identifier.
- **name** (string) - The name of the team.
- **users** (array) - List of users in the team.

#### Response Example
{
"status":1,
"request":"253b083d-6a40-4948-9173-563d14d22463",
"name":"my team",
"users":[
{"id":"da901fb83e6ce7a46a3f7a6de95cef","name":"my team user","email":"user@example.com","administrator":true,"devices":[{"name":"iphone","os":"iOS","os_version":"26","enabled":true,"administratively_disabled":false}]}
]
}
```

--------------------------------

### GET /1/sounds.json

Source: https://pushover.net/api

Retrieves a list of available notification sounds, including built-in tones and custom sounds uploaded to the application owner's account.

```APIDOC
## GET /1/sounds.json

### Description
Retrieves a list of available notification sounds for an application. This list includes built-in sounds and any custom sounds uploaded to the account that owns the application token.

### Method
GET

### Endpoint
https://api.pushover.net/1/sounds.json

### Parameters
#### Query Parameters
- **token** (string) - Required - Your application's API token.

### Response
#### Success Response (200)
- **sounds** (hash) - A dictionary where keys are the sound identifiers to be used in the `sound` parameter, and values are the human-readable names of the sounds.

#### Response Example
{
  "sounds": {
    "pushover": "Pushover (default)",
    "bike": "Bike",
    "custom_sound_id": "My Custom Sound"
  }
}
```

--------------------------------

### GET /1/messages.json

Source: https://pushover.net/api/client

Downloads all pending messages for a specific device. It is recommended to discard old messages if the client has not been run in a while.

```APIDOC
## GET /1/messages.json

### Description
Downloads all pending messages for a specific device. It is recommended to discard old messages if the client has not been run in a while.

### Method
GET

### Endpoint
`https://api.pushover.net/1/messages.json`

### Parameters
#### Query Parameters
- **secret** (string) - Required - Your user secret.
- **device_id** (string) - Required - The ID of the device for which to download messages.

### Request Example
```bash
curl "https://api.pushover.net/1/messages.json?secret=SGx2Su5onMcXU2EVozWG41Fws42bHo0aOrmA3tQ3jjRMSu1HwMEmOWNWPD7J&device_id=zQie8WjzFTWkMz5CcGrUNK2t5rR9zGTsfYQ7HHGs"
```

### Response
#### Success Response (200)
- **status** (integer) - Indicates the success of the request (1 for success).
- **request** (string) - A unique identifier for the request.
- **messages** (array) - An array of message objects.
  - **id** (integer) - The unique ID of the message for this device.
  - **id_str** (string) - A string representation of the message ID.
  - **umid** (integer) - The unique ID of the message across all devices for the user.
  - **umid_str** (string) - A string representation of the umid.
  - **title** (string) - The title of the message.
  - **message** (string) - The text content of the message.
  - **app** (string) - The name of the application that sent the message.
  - **aid** (integer) - The unique ID of the application that sent the message.
  - **aid_str** (string) - A string representation of the application ID.
  - **icon** (string) - The name of the application's icon.
  - **date** (integer) - A Unix timestamp of when the message was received by the API.
  - **queued_date** (integer) - A Unix timestamp of when the message was received by the API.
  - **dispatched_date** (integer) - A Unix timestamp of when the message was sent to notification servers.
  - **priority** (integer) - The priority level of the message.
  - **sound** (string) - The name of the sound file to play for the message.
  - **url** (string) - A supplementary URL included with the message.
  - **url_title** (string) - The title for the supplementary URL.
  - **acked** (integer) - Indicates if the message was acknowledged (used for Emergency-Priority messages).
  - **receipt** (string) - The receipt code for Emergency-Priority messages.
  - **html** (integer) - Indicates if the message contains HTML (1 for true, 0 for false).

#### Response Example
```json
{
  "status": 1,
  "request": "36fddffb-9f62-444b-bd17-5e7c7febb258",
  "messages": [
    {
      "id": 380698801670733826,
      "id_str": "380698801670733826",
      "message": "This message confirms that you are now able to receive messages on this device (my_device).\n\nVisit https://pushover.net/apps to view apps, plugins, and services to use with Pushover.",
      "app": "Pushover",
      "aid": 380698715771387905,
      "aid_str": "380698715771387905",
      "icon": "HopmnR5uQ4cmXen",
      "date": 1409605784,
      "priority": 0,
      "acked": 0,
      "umid": 380698801670733826,
      "umid_str": "380698801670733826",
      "title": "Welcome to Pushover!"
    },
    {
      "id": 380698969174458372,
      "id_str": "380698969174458372",
      "message": "test",
      "app": "Pushover",
      "aid": 380698715771387905,
      "aid_str": "380698715771387905",
      "icon": "default",
      "date": 1409605795,
      "priority": 0,
      "acked": 0,
      "umid": 380699115203346437,
      "umid_str": "380699115203346437",
      "title": ""
    }
  ]
}
```
```

--------------------------------

### Successful API Response Example

Source: https://pushover.net/api

A valid API request returns an HTTP 200 status with a JSON object containing a 'status' code of 1 and a unique 'request' identifier.

```json
{"status":1,"request":"647d2300-702c-4b38-8b2f-d56326ae460b"}
```

--------------------------------

### API Error Response Example

Source: https://pushover.net/api

Invalid input results in an HTTP 4xx status, a JSON object with a 'status' code other than 1, and an 'errors' array detailing the invalid parameters.

```json
{"user":"invalid","errors":["user identifier is         invalid"],  
         "status":0,"request":"5042853c-402d-4a18-abcb-168734a801de"}
```

--------------------------------

### GET /1/apps/limits.json

Source: https://pushover.net/api

Retrieve application usage statistics, including message limits, remaining messages, and reset timestamps.

```APIDOC
## GET /1/apps/limits.json

### Description

This endpoint allows you to retrieve your application's current message limit, remaining messages, and the timestamp when the message count will reset. This information is also available via HTTP headers on each message request.

### Method

GET

### Endpoint

`https://api.pushover.net/1/apps/limits.json`

### Parameters

#### Query Parameters

- **token** (string) - Required - Your application's API token.

### Response

#### Success Response (200 OK)

Returns a JSON object containing usage statistics.

- **limit** (integer) - The total message limit for the application per month.
- **remaining** (integer) - The number of messages remaining for the current month.
- **reset** (integer) - The Unix timestamp indicating when the message count will reset.

**Example Response Headers:**
```
X-Limit-App-Limit: 10000
X-Limit-App-Remaining: 7496
X-Limit-App-Reset: 1393653600
```

**Example Response Body:**
```json
{
  "limit": 10000,
  "remaining": 7496,
  "reset": 1393653600
}
```
```

--------------------------------

### Retrieve a List of Groups

Source: https://pushover.net/api/groups

Submit a GET request to this endpoint to fetch a list of all your delivery groups. Ensure you include your application's API token.

```http
GET https://api.pushover.net/1/groups.json?token=_YOUR_APP_TOKEN_
```

--------------------------------

### Get App Limits API Endpoint

Source: https://pushover.net/api

To retrieve application message limits in the response body, make a GET request to this endpoint, including your application's token as a parameter.

```http
https://api.pushover.net/1/apps/limits.json?token=_(your app         token)_
```

--------------------------------

### POST /devices.json

Source: https://pushover.net/api/client

Registers a new Open Client device for a user session.

```APIDOC
## POST /devices.json

### Description
Registers a new device for the authenticated user session. The 'os' parameter must be set to 'O' for Open Client devices.

### Method
POST

### Endpoint
https://api.pushover.net/1/devices.json

### Parameters
#### Request Body
- **secret** (string) - Required - The session secret obtained from login.
- **name** (string) - Required - A unique name for the device (A-Za-z0-9_-, max 25 chars).
- **os** (string) - Required - Must be 'O' for Open Client.

### Request Example
curl --form-string "secret=SGx2Su5onMcXU2EVozWG41Fws42bHo0aOrmA3tQ3jjRMSu1HwMEmOWNWPD7J" --form-string "name=my_device" --form-string "os=O" https://api.pushover.net/1/devices.json

### Response
#### Success Response (200)
- **status** (integer) - 1
- **id** (string) - The unique ID of the registered device

#### Response Example
{
  "status": 1,
  "request": "5e400a78-127b-4078-85e7-8f63cc78c9b2",
  "id": "zQie8WjzFTWkMz5CcGrUNK2t5rR9zGTsfYQ7HHGs"
}
```

--------------------------------

### Handling the Subscription Callback

Source: https://pushover.net/api/subscriptions

Upon successful subscription, the user is redirected back to the success URL with the new Pushover user key as a parameter.

```text
https://forum.example.com/settings/enable_pushover?rand=m5St1Fe67ly5d6&**pushover_user_key**=**sPfjsD2fGzEd9TR52DU31Hv4A61Vvk**
```

--------------------------------

### POST /1/subscriptions/migrate.json

Source: https://pushover.net/api/subscriptions

Migrates a legacy Pushover user key to a subscription key for a specific application and subscription.

```APIDOC
## POST /1/subscriptions/migrate.json

### Description
Migrates a legacy Pushover user key to a subscription key. Upon success, the application should discard the old user key and save the returned subscribed_user_key.

### Method
POST

### Endpoint
https://api.pushover.net/1/subscriptions/migrate.json

### Parameters
#### Request Body
- **token** (string) - Required - Your application's API token
- **subscription** (string) - Required - Your subscription's code
- **user** (string) - Required - The user's Pushover user key
- **device_name** (string) - Optional - A user's device name that the subscription should be limited to
- **sound** (string) - Optional - A user's preferred default sound

### Request Example
{
  "token": "APP_TOKEN",
  "subscription": "SUB_CODE",
  "user": "USER_KEY"
}

### Response
#### Success Response (200)
- **status** (integer) - Status code (1 for success)
- **subscribed_user_key** (string) - The new subscription key to save
- **request** (string) - Unique request identifier

#### Response Example
{
  "status": 1,
  "subscribed_user_key": "sPfjsD2fGzEd9TR52DU31Hv4A61Vvk",
  "request": "647d2300-702c-4b38-8b2f-d56326ae460b"
}
```

--------------------------------

### GET /1/groups.json

Source: https://pushover.net/api/groups

Retrieves a list of all delivery groups associated with the account.

```APIDOC
## GET /1/groups.json

### Description
Fetches a list of groups.

### Method
GET

### Endpoint
https://api.pushover.net/1/groups.json

### Parameters
#### Query Parameters
- **token** (string) - Required - Your application's API token.

### Response
#### Success Response (200)
- **groups** (array) - List of groups containing group key and name.

#### Response Example
{
  "status": 1,
  "request": "253b083d-6a40-4948-9173-563d14d22463",
  "groups": [
    {"group": "go4abk17j3itsva6thz99mdudgq2gm", "name": "my group"}
  ]
}
```

--------------------------------

### Device Registration API Request

Source: https://pushover.net/api/client

Register a new Desktop device by sending a POST request to the devices.json endpoint with the user's secret, device name, and 'O' for the OS. Store the returned device ID.

```bash
$ curl \
--form-string "secret=SGx2Su5onMcXU2EVozWG41Fws42bHo0aOrmA3tQ3jjRMSu1HwMEmOWNWPD7J" \
--form-string "name=my_device" \
--form-string "os=O" \
https://api.pushover.net/1/devices.json
```

--------------------------------

### GET /1/groups/_YOUR_GROUP_KEY_.json

Source: https://pushover.net/api/groups

Retrieves detailed information about a specific group, including its members.

```APIDOC
## GET /1/groups/{group_key}.json

### Description
Fetches a list of users in a group and the group name.

### Method
GET

### Endpoint
https://api.pushover.net/1/groups/{group_key}.json

### Parameters
#### Path Parameters
- **group_key** (string) - Required - The unique key of the group.

#### Query Parameters
- **token** (string) - Required - Your application's API token.

### Response
#### Success Response (200)
- **name** (string) - The name of the group.
- **users** (array) - List of members with user, device, memo, and disabled status.

#### Response Example
{
  "status": 1,
  "name": "My Delivery Group",
  "users": [
    {"user": "uoJCttEFQo8uoZ6REZHMGBjX2pmcdJ", "device": null, "memo": "Jim", "disabled": false}
  ]
}
```

--------------------------------

### Assign a License

Source: https://pushover.net/api/licensing

Assigns a license credit to a Pushover user account. This can be done via the user's Pushover user key or their email address. The license can optionally be restricted to a specific platform (Android, iOS, Desktop).

```APIDOC
## POST /1/licenses/assign.json

### Description
Assigns a license credit to a Pushover user account via their Pushover user key or email address. Optionally restricts the license to a specific platform.

### Method
POST

### Endpoint
https://api.pushover.net/1/licenses/assign.json

### Parameters
#### Query Parameters
- **token** (string) - Required - Your application's API token.
- **user** (string) - Required unless `email` is supplied - The user's Pushover user key.
- **email** (string) - Required unless `user` is supplied - The user's e-mail address.
- **os** (string) - Optional - Can be left blank to assign to the first operating system the user registers with, or one of `Android`, `iOS`, or `Desktop`.

### Request Example
```json
{
  "token": "your_app_api_token",
  "user": "user_pushover_key",
  "email": "user@example.com",
  "os": "Android"
}
```

### Response
#### Success Response (200)
- **status** (integer) - 1 indicates success.
- **credits** (integer) - The number of available license credits on your application.
- **request** (string) - A unique identifier for the request.

#### Response Example
```json
{
  "status": 1,
  "credits": 5,
  "request": "4f2a071d-fc2c-4d94-9cf2-68c069a599b4"
}
```

#### Error Response
- **status** (integer) - 0 indicates failure.
- **request** (string) - A unique identifier for the request.
- **errors** (object) - An object detailing the errors encountered.

#### Error Response Example
```json
{
  "status": 0,
  "request": "55f7df29-e2f3-4333-aeef-336334fafcee",
  "errors": {
    "token": ["is out of available license credits"]
  }
}
```
```

--------------------------------

### Message Formatting and Priority Parameters

Source: https://pushover.net/api

Details on how to apply HTML or monospace formatting, specify custom timestamps, and set message priority levels.

```APIDOC
## Message API Parameters

### Description
Optional parameters that can be included in message requests to control formatting, timing, and notification behavior.

### Parameters
#### Query/Body Parameters
- **html** (integer) - Optional - Set to 1 to enable HTML formatting in the message body.
- **monospace** (integer) - Optional - Set to 1 to enable monospace font. Cannot be used with html.
- **timestamp** (integer) - Optional - Unix timestamp of the original message to override the default server-received time.
- **priority** (integer) - Optional - Sets the notification priority: -2 (lowest), -1 (low), 0 (normal), 1 (high).
```

--------------------------------

### Generate and Redirect with Security Token (PHP)

Source: https://pushover.net/api/subscriptions

Generates a random security token, stores it in the session, and redirects the user to the Pushover subscription URL with the token appended. This is used to prevent CSRF attacks.

```php
<?php

$_SESSION["pushover_rand"] = bin2hex(openssl_random_pseudo_bytes(20));

header("Location: https://pushover.net/subscribe/Forum-f504h08fhlasdfj"
    . "?success=" . urlencode("https://forum.example.com/settings/enable_pushover?rand=" . $_SESSION["pushover_rand"])
    . "&failure=" . urlencode("https://forum.example.com/settings"));

?>
```

--------------------------------

### Handle License Assignment Success Response

Source: https://pushover.net/api/licensing

Successful license assignment returns an HTTP 200 status and a JSON object indicating the remaining credit count.

```json
{"status":1,"credits":5,"request":"4f2a071d-fc2c-4d94-9cf2-68c069a599b4"}
```

--------------------------------

### Successful Teams API Response

Source: https://pushover.net/api/teams

This is an example of a successful response from the Teams API, indicating a valid request with a status code of 1.

```json
{"status":1,"request":"f51d971c-ca76-4646-8c53-f1e72cfb2212"}
```

--------------------------------

### POST /1/groups/_YOUR_GROUP_KEY_/add_user.json

Source: https://pushover.net/api/groups

Adds an existing Pushover user to a delivery group.

```APIDOC
## POST /1/groups/{group_key}/add_user.json

### Description
Adds a user to a delivery group.

### Method
POST

### Endpoint
https://api.pushover.net/1/groups/{group_key}/add_user.json

### Parameters
#### Path Parameters
- **group_key** (string) - Required - The unique key of the group.

#### Request Body
- **token** (string) - Required - Your application's API token.
- **user** (string) - Required - The user's Pushover user key.
- **device** (string) - Optional - Device name to restrict messages.
- **memo** (string) - Optional - Free-text memo (max 200 chars).

### Request Example
{
  "token": "YOUR_APP_TOKEN",
  "user": "USER_KEY",
  "memo": "John Doe"
}
```

--------------------------------

### Failed Teams API Response

Source: https://pushover.net/api/teams

This is an example of a failed response from the Teams API, indicating an invalid request with a status code of 0 and an error message.

```json
{"status":0,
"request":"0b03d2fc-c223-4947-912a-d32244fc6c16",
"errors":[ "team token is invalid" ]}
```

--------------------------------

### Pushover Subscription Button HTML/CSS

Source: https://pushover.net/api/subscriptions

Use this HTML and CSS to create a styled button that directs users to your Pushover subscription URL. Ensure the href attribute points to your correct subscription URL.

```html
<style type="text/css">
.pushover_button {
    box-sizing:border-box !important;display:inline-block;background-color:#eee !important;background: url(data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iNjAycHgiIGhlaWdodD0iNjAycHgiIHZlcnNpb249IjEuMSIgdmlld0JveD0iNTcgNTcgNjAyIDYwMiIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48ZyB0cmFuc2Zvcm09InRyYW5zbGF0ZSg1OC45NjQgNTguODg4KSIgb3BhY2l0eT0iLjkxIj48ZWxsaXBzZSB0cmFuc2Zvcm09Im1hdHJpeCgtLjY3NDU3IC43MzgyMSAtLjczODIxIC0uNjc0NTcgNTU2LjgzIDI0MS42MSkiIGN4PSIyMTYuMzEiIGN5PSIxNTIuMDgiIHJ4PSIyOTYuODYiIHJ5PSIyOTYuODYiIGZpbGw9IiMyNDlkZjEiIGZpbGwtcnVsZT0iZXZlbm9kZCIgc3Ryb2tlLXdpZHRoPSIwIi8+PHBhdGggZD0ibTI4MC45NSAxNzIuNTFsNzQuNDgtOS44LTcyLjUyIDE2My42NmMxMi43NC0wLjk4IDI1LjIzMy01LjMwNyAzNy40OC0xMi45OCAxMi4yNT3LTcuNjggMjMuNTI3LTE3LjMxNyAzMy44Mi0yOC45MSAxMC4yODctMTEuNiAxOS4xODctMjQuNTAzIDI2LjctMzguNzEgNy41MT3LTE0LjIxMyAxMi45MDMtMjguMTggMTYuMTctNDEuOSAxLjk2LTguNDkzIDIuODYtMTYuNjYgMi43LTI0LjUtMC4xNjctNy44NC0yLjIxLTE0LjctNi4xMy0yMC41OHMtOS44ODM1LTEwLjYxNy0xNy44OS0xNC4yMWMtOC0zLjU5My0xOC44Ni01LjM5LTMyLjU4LTUuMzktMTYuMDA3IDAtMzEuNzcgMi42MTMtNDcyIDcuODQtMTUuNTEzIDUuMjI3LTI5Ljg4NyAxMi44MjMtNDMuMTIgMjIuNzktMTMuMjI3IDkuOTYtMjQuNzQgMjIuMzczLTM0LjU0IDM3LjI0LTkuOCAxNC44Ni0xNi44MjMgMzEuNzYzLTIxLjA3IDUwLjcxLTEuNjMzIDYuMjA3LTIuNjEzIDExLjE4Ny0yLjk0IDE0Ljk0LTAuMzI3IDMuNzYtMC40MDcgNi44NjMtMC4yIDkuMzEgMC4xNiAyLjQ1MyAwLjQ4MyA0LjMzMyAwLjk3IDUuNjQgMC40OTMgMS4zMDcgMC45MDMgMi42MTMgMS4yMyAzLjkyLTE2LjY2IDAtMjguODMtMy4zNS0zNi41MS0xMC4wNS03LjY3My02LjY5My05LjU1LTE4LjM3LTUuNjMtMzUuMDMgMy45Mi0xNy4zMTMgMTIuODIzLTMzLjgxIDI2LjcxLTQ5LjQ5IDEzLjg4LTE1LjY4IDMwLjM3My0yOS40ODMgNDkuNDgtNDEuNDEgMTkuMTEzLTExLjkyIDQwLjAyLTIxLjM5IDYyLjcyLTI4LjQxIDIyLjcwNy03LjAyNyA0NC44NC0xMC41NCA2Ni40LTEwLjU0IDE4Ljk0NyAwIDM0Ljg3IDIuNjkzIDQ3Ljc3IDguMDggMTIuOTA3IDUuMzkzIDIyLjk1MyAxMi41IDMwLjE0IDIxLjMyczExLjY3NyAxOS4xMSAxMy40NyAzMC44N2MxLjggMTEuNzYgMS4yMyAyNC4wMS0xLjcxIDM2Ljc1LTMuNTkzIDE1LjM1My0xMC4zNzMgMzAuNzktMjAuMzQgNDYuMzEtOS45NiAxNS41MTMtMjIuNDUzIDI5LjU2LTM3LjQ4IDQyLjE0LTE1LjAyNyAxMi41NzMtMzIuMjYgMjIuNzgtNTEuNyAzMC42Mi0xOS40MzMgNy44NC00MC4wOTMgMTEuNzYtNjEuOTggMTEuNzZoLTIuNDVsLTYyLjIzIDEzOS42NWgtNzAuNTZsMTM4LjY3LTMxMS42NHoiIGZpbGw9IiNmZmYiIHN0eWxlPSJ3aGl0ZS1zcGFjZTpwcmUiLz48L2c+PC9zdmc+) 3px 3px no-repeat;background-size:15px 15px;border-bottom:2px solid rgba(22,22,22,0.25) !important;border-right:2px solid rgba(22,22,22,0.25) !important;box-shadow: 0pt 2px 0pt rgba(255, 255, 255, 0.2) inset, 0pt 2px 0px rgba(0, 0, 0, 0.05) !important;border-radius:3px !important;color:#333 !important;display:inline-block !important;font:11px/18px "Helvetica Neue",Arial,sans-serif !important;font-weight:bold !important;cursor:pointer !important;height:22px !important;padding:1px 6px 20px 22px!important;overflow:hidden !important;text-decoration:none !important;vertical-align:middle !important;height:22px !important;
}
</style>

<a class="pushover_button" href="https://pushover.net/subscribe/_YOUR_SUBSCRIPTION_CODE_">
  Subscribe With Pushover
</a>
```

--------------------------------

### Response for Creating a Group

Source: https://pushover.net/api/groups

Upon successful creation of a group, the API returns a JSON object containing the new group's key.

```json
{
"status":1,
"request":"253b083d-6a40-4948-9173-563d14d22463",
"group":"go4abk17j3itsva6thz99mdudgq2gm"
}
```

--------------------------------

### Verify Security Token on Callback (PHP)

Source: https://pushover.net/api/subscriptions

Verifies the security token received from the Pushover callback URL against the token stored in the session. This ensures the request originated from a legitimate user session.

```php
<?php

if (empty($_SESSION["pushover_rand"]))
    die("no random token in session");

if (empty($_REQUEST["rand"]) || $_REQUEST["rand"] !== $_SESSION["pushover_rand"])
    die("no random token passed through pushover, possible security problem");

// verification passed, it's now ok to save $_REQUEST["pushover_user_key"]
...
?>
```

--------------------------------

### POST /1/teams/add_user.json

Source: https://pushover.net/api/teams

Adds a new user to the team with optional administrative privileges and group assignments.

```APIDOC
## POST /1/teams/add_user.json

### Description
Adds a user to your Team.

### Method
POST

### Endpoint
https://api.pushover.net/1/teams/add_user.json

### Parameters
#### Request Body
- **token** (string) - Required - Your team's API token.
- **email** (string) - Required - The user's e-mail address.
- **name** (string) - Optional - The user's full name.
- **password** (string) - Optional - The user's password.
- **instant** (string) - Optional - Set to 'true' to include an Instant Login link.
- **admin** (string) - Optional - Set to 'true' to add as an administrator.
- **group** (string) - Optional - Delivery group name to add the user to.

### Response
#### Success Response (200)
- **status** (integer) - Status code (1 for success).
- **request** (string) - Request identifier.
```

--------------------------------

### POST /users/login.json

Source: https://pushover.net/api/client

Authenticates a user with their email and password to retrieve a session secret and user ID.

```APIDOC
## POST /users/login.json

### Description
Authenticates a user and returns a session secret required for subsequent API calls. If two-factor authentication is enabled, a second request with the 'twofa' parameter is required.

### Method
POST

### Endpoint
https://api.pushover.net/1/users/login.json

### Parameters
#### Request Body
- **email** (string) - Required - The user's email address.
- **password** (string) - Required - The user's password.
- **twofa** (string) - Optional - The two-factor authentication code if required.

### Request Example
curl --form-string "email=user@example.com" --form-string "password=hunter2" https://api.pushover.net/1/users/login.json

### Response
#### Success Response (200)
- **status** (integer) - 1
- **request** (string) - Request ID
- **id** (string) - The user's Pushover user key
- **secret** (string) - The session secret for API authentication

#### Response Example
{
  "status": 1,
  "request": "7df577c3-da18-4fb3-898b-c1ab4985633b",
  "id": "uQiRzpo4DXghDmr9QzzfQu27cmVRsG",
  "secret": "SGx2Su5onMcXU2EVozWG41Fws42bHo0aOrmA3tQ3jjRMSu1HwMEmOWNWPD7J"
}
```

--------------------------------

### Check License Credits

Source: https://pushover.net/api/licensing

Retrieves the current number of available license credits for your application without assigning a license.

```APIDOC
## GET /1/licenses.json

### Description
Checks the number of available license credits for your application.

### Method
GET

### Endpoint
https://api.pushover.net/1/licenses.json

### Parameters
#### Query Parameters
- **token** (string) - Required - Your application's API token.

### Response
#### Success Response (200)
- **status** (integer) - 1 indicates success.
- **credits** (integer) - The number of available license credits on your application.
- **request** (string) - A unique identifier for the request.

#### Response Example
```json
{
  "status": 1,
  "credits": 5,
  "request": "142f8378-fd19-4cb7-9ea2-b18b15a07431"
}
```
```

--------------------------------

### Add a User to a Delivery Group

Source: https://pushover.net/api/groups

Submit a POST request to add an existing Pushover user to your Delivery Group. You must provide the user's Pushover user key.

```http
POST https://api.pushover.net/1/groups/_YOUR_GROUP_KEY_/add_user.json

Parameters:
  token (required) - your application's API token
  user (required) - the user's Pushover user key
  device (optional) - restrict messages to a specific device
  memo (optional) - associate data with the user
```

--------------------------------

### Constructing the Subscription URL

Source: https://pushover.net/api/subscriptions

The subscription URL includes encoded success and failure parameters to manage user redirection after the subscription process.

```text
https://pushover.net/subscribe/Forum-f504h08fhlasdfj?**success**=**https%3A%2F%2Fforum.example.com%2Fsettings%2Fenable_pushover%3Frand%3Dm5St1Fe67ly5d6**&**failure**=**https%3A%2F%2Fforum.example.com%2Fsettings**
```

--------------------------------

### Handle License Assignment Error Response

Source: https://pushover.net/api/licensing

Failed assignments return a status of 0 and an errors object. Avoid automatic retries for these errors.

```json
{"status":0,
"request":"55f7df29-e2f3-4333-aeef-336334fafcee",
"errors":{"token":["is out of available license credits"]}}
```

--------------------------------

### Application Registration

Source: https://pushover.net/api

Register your application to obtain an API token. This token is required for all API calls made on behalf of your application.

```APIDOC
## Application Registration

### Description
Register your application to obtain an API token. This token is required for all API calls made on behalf of your application. You can set your application's name and upload an icon that will appear with each message.

### Process
1. Register your application through the Pushover website.
2. Receive an API token (APP_TOKEN).
3. Use this token in the `token` parameter for all API requests.

### API Token Format
- Case-sensitive
- 30 characters long
- Contains characters from `[A-Za-z0-9]`

### Example API Token
`azGDORePK8gMaC0QOYAMyEEuzJnyUi` (This is an example and will not work.)

### Important Note
If you are distributing client-side libraries or applications, it is recommended that each end-user registers their own application to obtain their own API token, rather than including a single token with your software.
```

--------------------------------

### Device Registration API Success Response

Source: https://pushover.net/api/client

A successful device registration returns a JSON object with status 1 and the new device's unique ID.

```json
{"status":1,
"request":"5e400a78-127b-4078-85e7-8f63cc78c9b2",
"id":"zQie8WjzFTWkMz5CcGrUNK2t5rR9zGTsfYQ7HHGs"}
```

--------------------------------

### Response for Retrieving Group Information

Source: https://pushover.net/api/groups

The response includes the group's name and a 'users' array detailing each member with their user key, device, memo, and disabled status.

```json
{
"status":1,
"request":"4044780a-8b6d-4416-9c0f-f123bc1b6450",
"name":"My Delivery Group",
"users":[
{"user":"uoJCttEFQo8uoZ6REZHMGBjX2pmcdJ","device":null,"memo":"Jim","disabled":false},
{"user":"uZgLtMeFSRgdxLbpWbDDPM9v4wmEKu","device":"iphone","memo":"Mary","disabled":false},
]}

```

--------------------------------

### Download Pending Messages

Source: https://pushover.net/api/client

Use this `curl` command to download all pending messages for a specific device. Include your user secret and device ID as parameters. The response will be a JSON object containing message details.

```bash
$ curl "https://api.pushover.net/1/messages.json?secret=SGx2Su5onMcXU2EVozWG41Fws42bHo0aOrmA3tQ3jjRMSu1HwMEmOWNWPD7J&device_id=zQie8WjzFTWkMz5CcGrUNK2t5rR9zGTsfYQ7HHGs"
```

--------------------------------

### User Login API Request

Source: https://pushover.net/api/client

Submit a POST request to the users/login.json endpoint with user's email and password to obtain a session secret. Store the returned 'id' and 'secret' securely.

```bash
$ curl \
--form-string "email=user@example.com" \
--form-string "password=hunter2" \
https://api.pushover.net/1/users/login.json
```

--------------------------------

### POST /groups/_YOUR_GROUP_KEY_/enable_user.json

Source: https://pushover.net/api/groups

Resumes sending notifications to a specific user in a group.

```APIDOC
## POST /groups/_YOUR_GROUP_KEY_/enable_user.json

### Description
Resume sending notifications to a particular user in a group.

### Method
POST

### Endpoint
https://api.pushover.net/1/groups/_YOUR_GROUP_KEY_/enable_user.json

### Parameters
#### Request Body
- **token** (string) - Required - Your application's API token.
- **user** (string) - Required - The user's Pushover user key.
- **device** (string) - Optional - The device name to match for the user's group membership; if left blank, all users with the matching user key will be re-enabled.
```

--------------------------------

### POST /1/messages.json

Source: https://pushover.net/api

Send a message to one or more users or groups via the Pushover API. This endpoint allows for customization of message content, priority, attachments, and more.

```APIDOC
## POST /1/messages.json

### Description
Send a message to one or more users or groups via the Pushover API. This endpoint allows for customization of message content, priority, attachments, and more.

### Method
POST

### Endpoint
https://api.pushover.net/1/messages.json

### Parameters
#### Query Parameters
- **token** (string) - Required - Your application's API token.
- **user** (string) - Required - Your user/group key.
- **message** (string) - Required - The content of your message.
- **attachment** (binary) - Optional - A binary image attachment to send with the message.
- **attachment_base64** (string) - Optional - A Base64-encoded image attachment to send with the message.
- **attachment_type** (string) - Optional - The MIME type of the included attachment.
- **device** (string) - Optional - The name of a specific device to send the message to.
- **html** (integer) - Optional - Set to `1` to enable HTML parsing.
- **priority** (integer) - Optional - Message priority level (-2, -1, 0, 1, 2). Defaults to 0.
- **sound** (string) - Optional - The name of a supported sound to override the default.
- **timestamp** (integer) - Optional - A Unix timestamp for the message display time.
- **title** (string) - Optional - The title of your message. Defaults to your app's name.
- **ttl** (integer) - Optional - The number of seconds the message will live before being deleted.
- **url** (string) - Optional - A supplementary URL to show with your message.
- **url_title** (string) - Optional - A title for the supplementary URL.

### Request Example
```json
{
  "token": "azGDORePK8gMaC0QOYAMyEEuzJnyUi",
  "user": "uXXXXXXX",
  "message": "Hello from the API!",
  "title": "My App",
  "priority": 1
}
```

### Response
#### Success Response (200)
- **token** (string) - Acknowledgment token.
- **user** (string) - User or group key.
- **id** (string) - Message ID.
- **creation** (integer) - Timestamp of message creation.
- **delivery** (integer) - Timestamp of message delivery.
- **visible** (integer) - Timestamp of message visibility.
- **expires** (integer) - Timestamp of message expiration.
- **priority** (integer) - Message priority.
- **status** (integer) - Message status.
- **error** (string) - Error message if any.
- **request** (string) - Request ID.

#### Response Example
```json
{
  "status": 1,
  "request": "a1b2c3d4e5f67890",
  "ucls": [
    {
      "user": "uXXXXXXX",
      "token": "azGDORePK8gMaC0QOYAMyEEuzJnyUi",
      "id": "m1a2b3c4d5e6f789",
      "creation": 1434343434,
      "delivery": 1434343435,
      "visible": 1434343435,
      "expires": 0,
      "priority": 1,
      "status": 2
    }
  ]
}
```
```
Tokens:
Raw