Introduction

Set up with your agent

Copy a prompt with the quickstart, SDK guides and MCP connection. Sign in or create your account when the agent opens the browser.

Read the prompt

Help me send my first mobile push with Carillon in this project.

Read https://app.carillon.dev/docs/llms.txt, then https://app.carillon.dev/docs/quickstart and the SDK guide matching this codebase:
React Native: https://app.carillon.dev/docs/sdks/react-native
Swift: https://app.carillon.dev/docs/sdks/swift
Kotlin: https://app.carillon.dev/docs/sdks/kotlin

Connect the hosted MCP at https://app.carillon.dev/mcp using OAuth. Open the browser so I can sign in or create an account; never ask for my password.

List my organizations and select the appropriate workspace.
Reuse a matching app or create one after checking the existing apps.

Inspect the code and use the installed SDK API. Get an active mobile key with key_list. Never put a secret key in the mobile app.

Check provider credentials and guide me through any Apple/Firebase steps or device actions you cannot perform. Keep credential files and secrets out of chat and version control.

Configure the SDK, native capabilities and notification permission, then rebuild. Verify the device registration, send one notification only to my chosen test device, and inspect its trace. A provider acceptance is not proof of display on the phone. Report what was verified and what still needs my action.

Read the current MCP tool list; use the documented API or dashboard when a required action is not available as a tool.

Carillon sends notifications to iOS through APNs and Android through FCM. Your mobile app registers devices with an SDK. Your backend sends notifications with the REST API.

How it works

Create an app in the dashboard and upload its APNs or FCM credential.
Register a device using a mobile key and the Swift, Kotlin, or React Native SDK.
Send a notification from your backend with a secret key and POST /v1/messages.
Check the result with GET /v1/messages/{id} or in the dashboard.

The send endpoint returns 202 with a campaign ID. Delivery happens asynchronously. A delivery marked sent means APNs or FCM accepted it; it does not confirm display on the device.

Quickstart

Your first push notification in 10 minutes.

API reference

Endpoints, authentication, request fields, and responses.

Terms used in this documentation

Term	Meaning
App	A mobile application in Carillon. Its credentials, keys, devices, and campaigns belong to it. An app can include both iOS and Android.
Device	An APNs or FCM token registered to an app. A person using two devices has two registrations.
Audience	The recipients of a send: device IDs, all devices, or a saved set of filters.
Campaign	One accepted send request, addressed by the ID returned from `/v1/messages`.
Delivery	The result of sending a campaign to one device.

Find a task

Task	Page
Choose a key or rotate it	Authentication
Send from your backend	Send a notification
Filter recipients	Target an audience
Send later or at a local time	Schedule a message
Migrate existing tokens	Import devices
Record notification taps	Track opens
Diagnose a missing notification	Troubleshooting
Manage apps from a terminal or an agent	CLI · MCP server

Read with an LLM

Use llms.txt to find a page, or llms-full.txt for the complete documentation. Each guide also has a Copy Markdown button. API request and response schemas are in the API reference.