Skip to main content
POST
Send a push Live Activity notification
Send an update or end event to an existing Live Activity session.
Use "event": "end" to close the Live Activity. End events may include a final status, body, and dismiss_at timestamp.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

activity_id
string
required

Body

application/json

Live Activity update or end payload

app_id
string
required

Push app short ID.

event
enum<string>
required
Available options:
update,
end
title
string
subtitle
string
body
string
status
string
progress
number
Required range: 0 <= x <= 1
eta
string
image_url
string<uri>
accent_color
string
launch_url
string
Maximum string length: 2048
dismiss_at
string<date-time>
buttons
object[]
Maximum array length: 3
data
object

Response

Live Activity notification sent

status
integer
required

HTTP response status code

data
object
required