Metadata for Push Notifications and Live Activities

Push Notifications and Live Activities now support custom metadata. Add fields such as a customer ID, subscription amount, or job result, then view them in ActivitySmith on iOS or the web. Metadata does not appear on the Lock Screen.

Add metadata to your request

Include a metadata object with any extra information you want to attach to a Push Notification or Live Activity.

1
await activitysmith.notifications.send({
2
  title: "New subscription",
3
  message: "Customer upgraded to Pro plan",
4
  metadata: {
5
    customer_id: "382",
6
    plan: "Pro",
7
    amount: 29,
8
    trial: false,
9
  },
10
});

Get started

Metadata values can be strings, numbers, or booleans, with up to 50 fields per request.

Add metadata through the API or MCP server. See the Metadata documentation for examples and supported values.