Live Activities
Start, update and end Live Activities; device tokens.
SDK-facing (API-key) Live Activities surface: register push-to-start tokens
(iOS 17.2+) and running-activity update tokens, and report receipts/clicks.
Un-prefixed (/partner/...).
| Method | Path | Summary |
|---|---|---|
POST | /api/partner/live-activities/assets | Image URLs of the environment's templates — the SDK caches them for the iOS widget. |
POST | /partner/live-activities/:activityId/end | |
POST | /partner/live-activities/:activityId/update | |
POST | /partner/live-activities/event | |
POST | /partner/live-activities/push-token | |
POST | /partner/live-activities/register | |
POST | /partner/live-activities/start |
POST /api/partner/live-activities/assets
POST 200 x-api-keyImage URLs of the environment's templates — the SDK caches them for the iOS widget.
curl -X POST 'https://services.inverge.net/api/partner/live-activities/assets' \
-H 'x-api-key: nxs_live_xxx'POST /partner/live-activities/{activityId}/end
POST 200 x-api-keyPath parameters
Prop
Type
Body — EndActivityDto
Prop
Type
curl -X POST 'https://services.inverge.net/partner/live-activities/{activityId}/end' \
-H 'x-api-key: nxs_live_xxx' \
-H 'content-type: application/json' \
-d '{
"data": {},
"contentState": {},
"dismissalDate": "string"
}'POST /partner/live-activities/{activityId}/update
POST 200 x-api-keyPath parameters
Prop
Type
Body — UpdateActivityDto
Prop
Type
curl -X POST 'https://services.inverge.net/partner/live-activities/{activityId}/update' \
-H 'x-api-key: nxs_live_xxx' \
-H 'content-type: application/json' \
-d '{
"data": {},
"contentState": {},
"staleDate": "string"
}'POST /partner/live-activities/event
POST 202 x-api-keyBody — LiveActivityEventDto
Prop
Type
curl -X POST 'https://services.inverge.net/partner/live-activities/event' \
-H 'x-api-key: nxs_live_xxx' \
-H 'content-type: application/json' \
-d '{
"activityId": "order_42",
"type": "receipt"
}'POST /partner/live-activities/push-token
POST 200 x-api-keyBody — RegisterPushToStartDto
Prop
Type
curl -X POST 'https://services.inverge.net/partner/live-activities/push-token' \
-H 'x-api-key: nxs_live_xxx' \
-H 'content-type: application/json' \
-d '{
"activityType": "string",
"token": "fcm-or-apns-token"
}'POST /partner/live-activities/register
POST 200 x-api-keyBody — RegisterActivityDto
Prop
Type
curl -X POST 'https://services.inverge.net/partner/live-activities/register' \
-H 'x-api-key: nxs_live_xxx' \
-H 'content-type: application/json' \
-d '{
"activityId": "order_42",
"activityType": "string",
"platform": "ios"
}'POST /partner/live-activities/start
POST 200 x-api-keyBody — StartActivityDto
Prop
Type
curl -X POST 'https://services.inverge.net/partner/live-activities/start' \
-H 'x-api-key: nxs_live_xxx' \
-H 'content-type: application/json' \
-d '{
"activityId": "order_42"
}'