POST /api/push/start
Create a push group and get its join button.
Send the key as the x-api-key header. Creating a group is never billed. Errors are listed in errors and limits.
Body
| Field | Type | Instructions |
|---|---|---|
group | string | Required. The group name people see in the app. |
pushGroupId | string | Required. Any text that names the group. Every send and branding call uses it. |
brand | object | The brand on the group. See below. |
reuse | boolean | true gives each phone that joins its own copy of the group, so each phone records the website it joined from. Sends reach every phone either way. |
The brand object
| Field | Type | Instructions |
|---|---|---|
logo | string | A square image URL. The group's picture on every notification and in the app. |
name | string | The brand name shown in the app. Leave it out to show no brand name. |
description | string | A short line about the group, shown in the app. |
brand.color and brand.title are Live Activity fields. Push groups ignore them.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13
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.webp", "description": "Order updates from Acme" } }'
Response
Answers 201. groupId is the id the join button uses. Put links.iframe on a web page; the button works like the launch button, with the button types notify, subscribe, and follow.
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>" } }
Notes
- Each start makes a new join button. Starting again with the same
pushGroupIdadds another button to the same group, and sends reach the phones that joined through either one. - To change the name or brand later, use POST /api/push/branding.
- Push groups send no webhooks.
