Skip to content

Groups

A group puts several people behind one key. Put the group’s key (g_…) in a notification’s to and it goes to everyone in the group. Changing who’s in the group doesn’t require changing your code.

{ "title": "Server down", "message": "api-1 isn't responding", "priority": 1, "to": ["g_7mGmq2pVtR1DkW8xZb0sYcLnQe4uFj"] }

With an empty to, the notification goes to the project’s default audience. A group can only be used by projects of the same workspace.

Groups → New group: give it a name and the group’s key is created. Add people with Add member:

  • User key: the person copies it in the app from Settings → Your user key (u_…). Someone who subscribed to your project has a project-specific key that works too.
  • Device: send only to this device of the person (the device’s name in the app). You can add the same person separately with different devices.
  • Memo: up to 200 characters; only shown in the dashboard (“on call”, “warehouse lead”).
  • Pause: the member stops receiving notifications without leaving the group (time off, vacation); Resume brings them back.

Members’ emails never appear anywhere, only their keys.

The Team group exists automatically: everyone who joins your team is in it, and anyone who leaves the team drops out. You can’t add members to the team group by hand or delete it, but you can pause its members.

How many groups you can create depends on your plan.

With a project API key:

Request What it does
GET /v1/groups Groups
POST /v1/groups {"name": "On call"} Creates a group and returns its key
GET /v1/groups/{g_…} The group and its members
PATCH /v1/groups/{g_…} {"name": "…"} Renames it
DELETE /v1/groups/{g_…} Deletes the group
POST /v1/groups/{g_…}/members {"user": "u_…", "device": "iphone", "memo": "…"} Adds a member
PATCH /v1/groups/{g_…}/members/{id} {"disabled": true} Pauses / resumes a member, changes their device or memo
DELETE /v1/groups/{g_…}/members/{id} Removes a member

If you manage an on-call rota in your own system, pause and resume members at the start of each shift; the code that sends notifications always uses the same group key.

Pushover’s groups API works too (/1/groups.json, add_user, delete_user, disable_user, enable_user, rename): Pushover compatibility.