Customer.io

Customer.io Live Notifications API

Start, update, and end live notifications—real-time activities on the iOS Lock Screen and Dynamic Island, and in the Android notification shade. Your server drives the activity's content; Customer.io handles token lookup and push delivery.

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/live_notifications/start Start a live notification · Start a live notification #
Ask an LLM
“How do I start a Live Activity on someone's iPhone lock screen?”
“What do I need to start a live notification for a profile?”
Tell an agent
Start a {notification_type} live notification for {identifiers} with state {content_state}.
Start a live notification of type {notification_type} for {identifiers} using attributes {attributes} and state {content_state}.
POST /v1/live_notifications/update Update a running live notification · Update a live notification #
Ask an LLM
“How do I push a new state to a Live Activity that's already running?”
“Do I need to send the full content state when updating a live notification?”
Tell an agent
Update live notification {instance_id} with state {content_state}.
Push new content {content_state} to running activity {instance_id}.
POST /v1/live_notifications/end End a live notification · End a live notification #
Ask an LLM
“How do I end a Live Activity and dismiss it from the lock screen?”
“Can I send a final state when ending a live notification?”
Tell an agent destructive · confirm first
End live notification {instance_id}.
Finish activity {instance_id} with final state {content_state}.
GET /v1/live_notifications/{instance_id} Get a live notification's status · Get a live notification's status #
Ask an LLM
“Is a live notification still running, and was its last update delivered?”
“How do I check the lifecycle of a Live Activity?”
Tell an agent
Get the status of live notification {instance_id}.
Check whether activity {instance_id} is still active.

Documentation

📖
Documentation
https://docs.customer.io/integrations/api/app/
📖
Documentation
https://docs.customer.io/integrations/data-in/connections/http-api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/customer-io/refs/heads/main/openapi/customer-io-live-notifications-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/customer-io:customer-io-live-notifications-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

customer-io-live-notifications-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.0.0
  title: Customer.io App Live Notifications API
  description: Our App API provides ways to trigger messages and retrieve information about people, campaigns, broadcasts, and more.
servers:
- url: https://api.customer.io
  description: The base URL for broadcasts, transactional messages, and data-retrieval APIs. These endpoints use bearer authorization, and require a [token that you generate in the UI](https://fly.customer.io/settings/api_credentials?keyType=app).
- url: https://api-eu.customer.io
  description: The base URL for broadcasts, transactional messages, and data-retrieval APIs (EU region). These endpoints use bearer authorization, and require a [token that you generate in the UI](https://fly.customer.io/settings/api_credentials?keyType=app).
tags:


# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/customer-io/refs/heads/main/openapi/customer-io-live-notifications-api-openapi.yml