Skip to content
Preview: the PushFleet API isn't live yet. Join the waitlist

Authentication

All requests go to https://api.pushfleet.com/v1 over HTTPS, as JSON. HTTP/2 is supported, and you can send and receive gzip or brotli.

Send your key as a bearer token:

Terminal window
curl https://api.pushfleet.com/v1/messages/msg_2Xk9fQ \
-H "Authorization: Bearer $PUSHFLEET_SECRET_KEY"

A missing or unknown key gets 401 invalid_key. A restricted key without the scope a request needs gets 403 missing_scope. API keys covers the three kinds of key and every scope.

pf_sk_test_… keys talk to your test environment and pf_sk_live_… keys talk to live. Requests never carry an environment field, so a test key can’t send a live push.

PushFleet’s IDs carry a prefix so you can tell them apart in logs:

Prefix Object
msg_ A message
dev_ A device
bat_ A batch
key_ An API key

Your own user IDs are plain strings you choose, with no prefix.