iOS Live Activities API

Manage iOS Live Activities via API

updateLiveActivity

Use this method to manage iOS Live Activities.

Apple documentation:

• About Live Activities

• Updating and ending Live Activities with ActivityKit push notifications

/updateLiveActivity

POST https://api.pushwoosh.com/json/1.3/updateLiveActivity

Allows to create and manage iOS Live Activities.

Request Body

Name	Type	Description
auth*	string	API access token from Pushwoosh Control Panel.
application*	string	Pushwoosh application code.
notifications*	array	JSON array of message parameters. See details in a request example below.

200

{
    "status_code": 200,
    "status_message": "OK",
    "response": {
        "Messages": [
            "C3F8-C3863ED4-334AD4F1" // message code
        ]
    }
}

Request example

Example

{
  "request": {
    "application": "XXXXX-XXXXX", // Required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H", // Required. API access token from Pushwoosh Control Panel
    "notifications": [
      {
        // message settings 
        "ios_live_activity": { // Required. Live Activity data to update Live Activity in iOS
          "event": "update", // Required. Use "update" to update Live Activity or "end" to close Live Activity
          "content-state": { // Required. Object with key-value pairs used to pass data to Live Activity for updating its content
            "courierName": "NUMBER: 15",
            "deliveryStatus": "Done"
          },
          "dismissal-date": 12345678 // Optional. Time of ending Live Activity in seconds
        },
        "devices": [  // Required. List of devices HWIDs to show Live Activity
          "B0974134-FD5A-450F-94EB-F23442D83BC7"
        ]
      }
    ]
  }
}

Read this article to learn more about working with Live Activities using the Pushwoosh iOS SDK.