Skip to content
PocketbellAPI

API reference

Pocketbell API v1

Section titled “Pocketbell API v1”

Send notifications to your iPhone, iPad and Mac from anything that can make an HTTP request.

Authentication. Create a Source in the Pocketbell app and send its API key as a bearer token: Authorization: Bearer pb_live_…. A webhook Source needs no key; its URL is the secret.

Retries. Send an Idempotency-Key header, and a repeated request returns the first notification instead of sending another.

Errors. Every error has a machine-readable code. Plan limits answer 403 with pro_required; the month’s notifications used up answers 429 with monthly_limit_reached (a Critical notification still goes out: on Pro always, on Free for 100 more), and a Free account’s month of questions used up answers 429 with question_limit.

New here? Start with the docs: send a notification, Critical notifications, webhooks and Live Activities.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/v1/messages/{id}
POST
/v1/messages/{id}/cancel
POST
/v1/messages
POST
/v1/hooks/{token}
GET
/v1/sources
POST
/v1/sources
PUT
/v1/sources/order
DELETE
/v1/sources/{id}
PATCH
/v1/sources/{id}
POST
/v1/sources/{id}/key
POST
/v1/sources/{id}/messages
GET
/v1/sources/{id}/callback-secret
POST
/v1/sources/{id}/callback-secret
GET
/v1/sources/{id}/event
POST
/v1/sources/{id}/test
DELETE
/v1/messages/{id}
PATCH
/v1/messages/{id}
GET
/v1/messages
GET
/v1/messages/{id}/deliveries
POST
/v1/messages/{id}/acknowledge
POST
/v1/messages/{id}/answer
POST
/v1/messages/{id}/delivered
GET
/v1/devices
PUT
/v1/devices
DELETE
/v1/devices/{id}
PATCH
/v1/devices/{id}
PUT
/v1/live-activities
POST
/v1/auth/nonce
POST
/v1/auth/apple
DELETE
/v1/auth/session
GET
/v1/account
DELETE
/v1/account
PUT
/v1/account/quiet-hours
DELETE
/v1/account/quiet-hours
POST
/v1/purchases
POST
/v1/app-store/notifications

Authentication

Section titled “Authentication”

sourceKey

Section titled “sourceKey”

The Source’s API key, pb_live_…

Security scheme type: http

session

Section titled “session”

A signed-in app’s session token, pb_sess_…

Security scheme type: http