Quick Start
Send a first push notification in three steps.
1. Start a push group
group is the name people see. pushGroupId is any text that names the group. Send the same value on every later call.
1 2 3 4 5 6 7 8 9 10 11 12
curl -X POST https://api.webliveactivity.com/api/push/start \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "group": "Acme Orders", "pushGroupId": "acme-orders", "reuse": true, "brand": { "name": "Acme", "logo": "https://acme.example/logo.png" } }'
The response (201) has links.iframe, the join button. See POST /api/push/start.
1 2 3 4 5 6 7 8
{ "ok": true, "groupId": "pg-7hk3mzq2wd9x", "pushGroupId": "acme-orders", "links": { "iframe": "<iframe src=\"https://api.webliveactivity.com/embed/button?type=notify&userId=pg-7hk3mzq2wd9x\" width=\"340\" height=\"95\" style=\"border:0;color-scheme:light\"></iframe>" } }
2. Let users join
Paste links.iframe into a web page. On a phone, a tap joins the group. On a computer, a click shows a QR code to scan with the phone's camera. To change its color or use it on a dark page, see the launch button.
3. Send a notification
Every phone in the group gets it. See POST /api/push/send.
1 2 3 4 5 6 7 8 9 10 11
curl -X POST https://api.webliveactivity.com/api/push/send \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "pushGroupId": "acme-orders", "title": "Your order shipped!", "subtitle": "Order #1234", "message": "Your package is on the way. Expected delivery: tomorrow by 5 PM.", "imageUrl": "https://acme.example/shipped.webp", "actionURL": "https://acme.example/orders/1234" }'
The response gives targeted, the number of phones it was sent to. It is 0 until someone joins, and then nothing is billed.
