POST /api/update

Push new content to one or more running activities.

Only send the fields that changed. The state merges into the current state on the device, so a call carrying just primaryText leaves everything else alone.

By activity id

Target a single activity by its activityId.

curl -X POST https://api.webliveactivity.com/api/update \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: wla_your_key' \
  -d '{
  "activityId": "act-8f2c1a",
  "widgetContainerId": "acme-orders",
  "state": {
    "primaryText": "Out for delivery",
    "stage": "On the way",
    "progress": 0.7,
    "estimatedMinutes": 8
  }
}'

By multiple activity ids

Pass an array of ids to push the same state to several activities at once.

curl -X POST https://api.webliveactivity.com/api/update \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: wla_your_key' \
  -d '{
  "activityIds": [
    "act-8f2c1a",
    "act-9k4d2b"
  ],
  "widgetContainerId": "acme-orders",
  "state": {
    "secondaryText": "Running behind schedule"
  }
}'

By group

Target a group to push the same state to every activity in it.

curl -X POST https://api.webliveactivity.com/api/update \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: wla_your_key' \
  -d '{
  "group": "order-tracker",
  "widgetContainerId": "acme-orders",
  "state": {
    "secondaryText": "Kitchen is busy tonight"
  }
}'

Response

Returns { ok, targeted, unknown }: how many activities were pushed, and any ids that did not resolve.

{
  "ok": true,
  "targeted": 3,
  "unknown": []
}

Examples

Update with an alert

Set priority: 10 to deliver immediately and play a sound; a countdown sends one on its own when it reaches countdownTo. Leave it out (or send 5) for a silent refresh.

curl -X POST https://api.webliveactivity.com/api/update \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: wla_your_key' \
  -d '{
  "activityId": "act-8f2c1a",
  "widgetContainerId": "acme-orders",
  "priority": 10,
  "state": {
    "primaryText": "Your driver is arriving",
    "progress": 0.95,
    "estimatedMinutes": 1
  }
}'

Advance segmented steps

Send the full segments array with updated complete values. The array is replaced, not merged.

curl -X POST https://api.webliveactivity.com/api/update \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: wla_your_key' \
  -d '{
  "activityId": "act-8f2c1a",
  "widgetContainerId": "pizza-tracker",
  "state": {
    "primaryText": "On the way",
    "segments": [
      {
        "label": "Cooking",
        "complete": true
      },
      {
        "label": "On the way",
        "complete": false
      },
      {
        "label": "Delivered",
        "complete": false
      }
    ]
  }
}'

Update a versus score

The versus object merges one level down, so only send what changed.

curl -X POST https://api.webliveactivity.com/api/update \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: wla_your_key' \
  -d '{
  "activityId": "act-8f2c1a",
  "widgetContainerId": "csgo-scores",
  "state": {
    "versus": {
      "leftScore": "16",
      "rightScore": "14",
      "activeSide": "left",
      "leftStatus": "Winner"
    }
  }
}'

Swap the layout live

Change the layout on an update to switch the activity's type mid-flight.

curl -X POST https://api.webliveactivity.com/api/update \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: wla_your_key' \
  -d '{
  "activityId": "act-8f2c1a",
  "widgetContainerId": "acme-orders",
  "state": {
    "layout": "picture",
    "primaryText": "Delivered",
    "headerIconUrl": "https://acme.example/delivered-photo.jpg",
    "accessoryText": "Just now"
  }
}'

Restart an expired activity

When restart is true (or when the activity is no longer on screen), the activity restarts instead of updating in place.

curl -X POST https://api.webliveactivity.com/api/update \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: wla_your_key' \
  -d '{
  "activityId": "act-8f2c1a",
  "widgetContainerId": "acme-orders",
  "restart": true,
  "state": {
    "primaryText": "New update available",
    "progress": 0.5
  }
}'