# Atomic.io documentation

> Atomic.io is an in-app engagement platform that delivers personalised, action-oriented content (Action Cards) into mobile and web apps. This site documents the platform, its REST APIs, native SDKs (iOS, Android, Web, React Native, Flutter, Cordova) and integrations.

The canonical home of the documentation is https://documentation.atomic.io. Source files live in `docs/` and are written in Markdown/MDX.

## Quick start

- [Quick start introduction](https://documentation.atomic.io/quick-start/introduction): the fastest path to seeing Atomic working in an app.
- [Examples](https://documentation.atomic.io/quick-start/examples): reference implementations and sample apps.

## Concepts and platform guide

- [Atomic 101](https://documentation.atomic.io/guide/getting-started/atomic-101): mental model — Action Cards, streams, customers, action flows.
- [Cards](https://documentation.atomic.io/guide/cards/overview): authoring, lifecycle, templates, approvals, overflow menu.
- [Action flows](https://documentation.atomic.io/guide/action-flows/overview): triggers (event, API, schedule), steps, A/B testing, analytics.
- [Customers](https://documentation.atomic.io/guide/customers/model): identity, profile data, segmentation, preferences.
- [Push notifications](https://documentation.atomic.io/guide/push-notifications/overview): APNs and FCM setup, payloads, delivery.
- [Analytics](https://documentation.atomic.io/guide/analytics/overview): event model, dashboards, exports.
- [Configuration](https://documentation.atomic.io/guide/configuration/overview): organisation, environments, brands, themes.
- [Organization & Workbench](https://documentation.atomic.io/guide/organization/overview): workspaces, roles, permissions.
- [Tools](https://documentation.atomic.io/guide/tools/overview): Workbench tooling for authors and developers.

## SDKs

- [SDK overview & install](https://documentation.atomic.io/sdks/install): supported platforms, versioning, install instructions.
- [iOS SDK](https://documentation.atomic.io/sdks/ios) — UIKit container.
- [iOS SwiftUI SDK](https://documentation.atomic.io/sdks/ios-swiftui) — SwiftUI integration.
- [Android SDK](https://documentation.atomic.io/sdks/android) — Views-based.
- [Android Compose SDK](https://documentation.atomic.io/sdks/android-compose) — Jetpack Compose integration.
- [Web SDK](https://documentation.atomic.io/sdks/web) — JavaScript/TypeScript embedding.
- [React Native SDK](https://documentation.atomic.io/sdks/react-native).
- [Flutter SDK](https://documentation.atomic.io/sdks/flutter).
- [Cordova SDK](https://documentation.atomic.io/sdks/cordova).
- [SDK authentication (JWT)](https://documentation.atomic.io/sdks/auth-SDK): signing JWTs, key rotation, troubleshooting.
- [SDK analytics](https://documentation.atomic.io/sdks/sdk-analytics): events emitted by the SDKs.
- [Offline and connectivity](https://documentation.atomic.io/sdks/offline-and-connectivity): caching and degraded-network behaviour.
- [Dark mode](https://documentation.atomic.io/sdks/dark-mode).
- [SDK release notes](https://documentation.atomic.io/sdks/sdk-release).

## REST API

- [API overview](https://documentation.atomic.io/api/overview): base URLs, authentication, conventions.
- [API credentials](https://documentation.atomic.io/api/api-credentials): creating and scoping API keys.
- [Auth](https://documentation.atomic.io/api/auth): JWT signing keys.
- [Card API](https://documentation.atomic.io/api/card-api): create, target, dismiss, query cards.
- [Action flow API](https://documentation.atomic.io/api/action-flow-api): trigger flows from your backend.
- [Users API](https://documentation.atomic.io/api/users-api): create, update, delete end-users.
- [User preferences API](https://documentation.atomic.io/api/user-preferences).
- [Environments API](https://documentation.atomic.io/api/environments-api).
- [Analytics — real-time API](https://documentation.atomic.io/api/analytics-real-time-api).
- [Analytics — batched API](https://documentation.atomic.io/api/analytics-batched-api).
- [SNS platforms](https://documentation.atomic.io/api/sns-platforms): push platform registration.
- [Webhooks](https://documentation.atomic.io/api/webhooks): outbound event delivery.
- [Audit log](https://documentation.atomic.io/api/audit-log).
- [Using Insomnia](https://documentation.atomic.io/api/using-insomnia): pre-built workspace for the API.
- [API and system limits](https://documentation.atomic.io/api/api-and-system-limits): rate limits, payload sizes, quotas.

## Integrations

- [Integration overview](https://documentation.atomic.io/integration/overview).
- [Integrating the SDKs](https://documentation.atomic.io/integration/integrating-the-sdks).
- Custom: [overview](https://documentation.atomic.io/integration/custom-integration-overview), [triggering action flows](https://documentation.atomic.io/integration/custom-triggering-action-flows), [syncing profile data](https://documentation.atomic.io/integration/custom-syncing-profile-data), [extracting analytics](https://documentation.atomic.io/integration/custom-extracting-analytics).
- Salesforce Marketing Cloud: [overview](https://documentation.atomic.io/integration/salesforce-marketing-cloud-overview), [Journey Builder](https://documentation.atomic.io/integration/salesforce-marketing-cloud-journey-builder), [Automation Studio](https://documentation.atomic.io/integration/salesforce-marketing-cloud-automation-studio), [Data Extensions](https://documentation.atomic.io/integration/salesforce-marketing-cloud-data-extensions).
- Adobe Marketo Engage: [overview](https://documentation.atomic.io/integration/adobe-marketo-engage-overview), [self-service flow steps](https://documentation.atomic.io/integration/adobe-marketo-engage-self-service-flow-steps), [track custom activities](https://documentation.atomic.io/integration/adobe-marketo-engage-track-custom-activities), [update lead records](https://documentation.atomic.io/integration/adobe-marketo-engage-update-lead-records).
- Google Analytics: [overview](https://documentation.atomic.io/integration/google-analytics-overview), [sync events](https://documentation.atomic.io/integration/google-analytics-sync-events).
- [AWS — sync analytics to S3](https://documentation.atomic.io/integration/aws-sync-analytics-to-s3).
- [Microsoft Teams — post webhook to channel](https://documentation.atomic.io/integration/microsoft-teams-post-webhook-to-channel).
- [Slack — post webhook to channel](https://documentation.atomic.io/integration/slack-post-webhook-to-channel).

## Resources

- [Glossary](https://documentation.atomic.io/resources/glossary): definitions of Atomic-specific terms.
- [Changelog](https://documentation.atomic.io/resources/changelog): platform and SDK release notes (RSS/Atom feeds available).
- [Data tenancy](https://documentation.atomic.io/resources/data-tenancy): regions and data residency.
- [IP addresses](https://documentation.atomic.io/resources/ip-addresses): outbound IPs for allow-listing.
- [Report concerns](https://documentation.atomic.io/resources/report-concerns): security and trust contact.

## Support

- [Support](https://documentation.atomic.io/support): how to get help and access the support portal.