# Pushctl Documentation

> Guides and API reference for configuring Pushctl, integrating its SDKs, and delivering push notifications.

## Docs

- [Push notifications under control](https://docs.pushctl.com/index.md): Configure your mobile applications, connect provider credentials, and deliver push notifications with Pushctl.
- [Quickstart](https://docs.pushctl.com/getting-started/quickstart.md): Create an application, connect a provider, integrate an SDK, and send your first Pushctl notification.
- [How Pushctl works](https://docs.pushctl.com/getting-started/how-pushctl-works.md): Understand Pushctl teams, applications, provider credentials, users, installations, and delivery events.
- [Sign up](https://docs.pushctl.com/account/sign-up.md): Create a Pushctl account and start your personal team.
- [Sign in](https://docs.pushctl.com/account/sign-in.md): Sign in with a password or passkey and complete two-factor authentication when enabled.
- [Reset a forgotten password](https://docs.pushctl.com/account/forgot-password.md): Request a password-reset email and choose a new Pushctl password.
- [Verify your email](https://docs.pushctl.com/account/verify-email.md): Verify a new or changed email address and resend the verification message.
- [Profile and appearance](https://docs.pushctl.com/account/profile.md): Update your Pushctl name, email address, and interface appearance.
- [Account security](https://docs.pushctl.com/account/security.md): Change your password, configure two-factor authentication, and manage passkeys.
- [Manage teams](https://docs.pushctl.com/teams/overview.md): Create, switch, rename, leave, and delete Pushctl teams.
- [Members and roles](https://docs.pushctl.com/teams/members-and-roles.md): Invite team members, understand role permissions, and manage pending invitations.
- [Manage applications](https://docs.pushctl.com/applications/overview.md): Create, inspect, update, enable, and disable Pushctl applications.
- [Provider credentials](https://docs.pushctl.com/applications/provider-credentials.md): Connect and replace Apple APNs and Firebase FCM credentials for an application.
- [Application tokens](https://docs.pushctl.com/applications/tokens.md): Create, store, scope, rotate, and revoke Pushctl application tokens.
- [Installations](https://docs.pushctl.com/applications/installations.md): Find registered devices, understand permission and validity states, and inspect delivery history.
- [Send a notification](https://docs.pushctl.com/notifications/send.md): Compose and send visible or data-only notifications from the Pushctl dashboard.
- [Delivery results](https://docs.pushctl.com/notifications/delivery-results.md): Interpret notification status, aggregate lifecycle counts, and per-installation errors.
- [Common issues](https://docs.pushctl.com/troubleshooting/common-issues.md): Resolve common account, credential, token, installation, and notification delivery problems.
- [Choose an SDK](https://docs.pushctl.com/sdks/overview.md): Choose the Pushctl SDK for native Android, native iOS, Capacitor, or Laravel.
- [Android quickstart](https://docs.pushctl.com/sdks/android/quickstart.md): Install and initialize the Pushctl Android SDK with Firebase Cloud Messaging.
- [Android identity and events](https://docs.pushctl.com/sdks/android/identity-and-events.md): Associate Android installations with users and handle foreground or opened notifications.
- [Android SDK reference](https://docs.pushctl.com/sdks/android/reference.md): Reference Android initialization options, methods, models, and notification listeners.
- [Android troubleshooting](https://docs.pushctl.com/sdks/android/troubleshooting.md): Resolve Firebase, permission, registration, channel, and open-handler issues on Android.
- [iOS quickstart](https://docs.pushctl.com/sdks/ios/quickstart.md): Install and initialize the Pushctl iOS SDK and register with APNs.
- [iOS identity and delivery events](https://docs.pushctl.com/sdks/ios/delivery-events.md): Identify iOS users, handle notification callbacks, and add confirmed background delivery.
- [iOS SDK reference](https://docs.pushctl.com/sdks/ios/reference.md): Reference iOS initialization options, methods, state, and notification models.
- [iOS troubleshooting](https://docs.pushctl.com/sdks/ios/troubleshooting.md): Resolve APNs token, environment, permission, extension, and callback issues on iOS.
- [Capacitor quickstart](https://docs.pushctl.com/sdks/capacitor/quickstart.md): Install the Pushctl Capacitor plugin and register an iOS or Android installation.
- [Capacitor native setup](https://docs.pushctl.com/sdks/capacitor/native-setup.md): Configure Firebase on Android and APNs with optional confirmed delivery on iOS.
- [Capacitor SDK reference](https://docs.pushctl.com/sdks/capacitor/reference.md): Reference Capacitor plugin methods, options, permission states, and events.
- [Capacitor troubleshooting](https://docs.pushctl.com/sdks/capacitor/troubleshooting.md): Resolve native synchronization, Firebase, APNs, permission, listener, and state issues.
- [Laravel quickstart](https://docs.pushctl.com/sdks/laravel/quickstart.md): Install and configure the Pushctl Laravel SDK and send your first notification.
- [Laravel notification channel](https://docs.pushctl.com/sdks/laravel/notifications.md): Send Pushctl messages through Laravel notifiables, routes, and queued notifications.
- [Laravel message options](https://docs.pushctl.com/sdks/laravel/message-options.md): Build visible and data-only Pushctl messages with delivery and platform options.
- [Laravel troubleshooting](https://docs.pushctl.com/sdks/laravel/troubleshooting.md): Resolve configuration, recipient routing, response, timeout, and duplicate-send issues.
- [API overview](https://docs.pushctl.com/reference/overview.md): Use the Pushctl v1 API to register installations, send notifications, and report delivery events.
- [Authentication](https://docs.pushctl.com/reference/authentication.md): Authenticate Pushctl API requests with scoped application bearer tokens.
- [Errors and rate limits](https://docs.pushctl.com/reference/errors-and-limits.md): Handle Pushctl HTTP errors, validation responses, and per-application rate limits.
- [Idempotency](https://docs.pushctl.com/reference/idempotency.md): Retry notification sends and delivery events without creating duplicates.
- [Register an installation](https://docs.pushctl.com/api-reference/installations/register-an-installation.md): Creates or replaces an installation and associates it with an optional external user.
- [Update an installation](https://docs.pushctl.com/api-reference/installations/update-an-installation.md): Updates the user association or permission state for an existing installation.
- [Get an installation](https://docs.pushctl.com/api-reference/installations/get-an-installation.md): Returns an installation belonging to the authenticated application.
- [Send a notification](https://docs.pushctl.com/api-reference/notifications/send-a-notification.md): Queues a notification for eligible installations belonging to the specified external users.
- [List notifications](https://docs.pushctl.com/api-reference/notifications/list-notifications.md): Returns paginated notification history, optionally filtered by status.
- [Get a notification](https://docs.pushctl.com/api-reference/notifications/get-a-notification.md): Returns aggregate lifecycle counts for a notification.
- [Report a delivery event](https://docs.pushctl.com/api-reference/delivery-events/report-a-delivery-event.md): Idempotently records a received, displayed, opened, or dismissed event.

## OpenAPI Specs

- [openapi](https://docs.pushctl.com/openapi.yaml)

## Optional

- [Documentation](https://pushctl.com/docs)
- [Blog](https://pushctl.com/blog)