# PushEngage APIs Documentation

> Empower your apps with push notifications for all browsers and mobile apps.

Every page below is also available as markdown: append `.md` to its URL.
The full documentation in a single file: https://www.pushengage.com/api/llms-full.txt

## Docs

- [MCP Server & Agent Skills](https://www.pushengage.com/api/ai-agents.md): Connect AI agents like Claude, Cursor, and Windsurf to PushEngage with the official MCP server and Agent Skills.
- [Mobile SDK Overview](https://www.pushengage.com/api/mobile-sdk.md): PushEngage Mobile SDK enables push notifications for iOS, Android, Flutter, and React Native apps.
- [Using PushEngage with Jetpack Compose](https://www.pushengage.com/api/mobile-sdk/android/jetpack-compose.md): Guide for integrating PushEngage Android SDK with Jetpack Compose apps — permissions, deep linking, and best practices.
- [Android Quickstart](https://www.pushengage.com/api/mobile-sdk/android/quickstart.md): Set up PushEngage push notifications in your Android app in under 15 minutes.
- [Android SDK Reference](https://www.pushengage.com/api/mobile-sdk/android/sdk-reference.md): Complete API reference for the PushEngage Android SDK.
- [Flutter Quickstart](https://www.pushengage.com/api/mobile-sdk/flutter/quickstart.md): Set up PushEngage push notifications in your Flutter app in under 15 minutes.
- [Flutter SDK Reference](https://www.pushengage.com/api/mobile-sdk/flutter/sdk-reference.md): Complete API reference for the PushEngage Flutter SDK.
- [iOS App Store Compliance Checklist](https://www.pushengage.com/api/mobile-sdk/ios/appstore-compliance.md): Step-by-step checklist to ensure your iOS app with PushEngage push notifications passes Apple's App Store review, including privacy manifest requirements and migration from OneSignal or FCM.
- [iOS Quickstart](https://www.pushengage.com/api/mobile-sdk/ios/quickstart.md): Set up PushEngage push notifications in your iOS app in under 15 minutes.
- [iOS SDK Reference](https://www.pushengage.com/api/mobile-sdk/ios/sdk-reference.md): Complete API reference for the PushEngage iOS SDK.
- [PushEngage with Expo and Bare Workflow](https://www.pushengage.com/api/mobile-sdk/react-native/expo-guide.md): How to integrate PushEngage React Native SDK with Expo Development Builds or bare React Native projects, and when to use each.
- [React Native Quickstart](https://www.pushengage.com/api/mobile-sdk/react-native/quickstart.md): Set up PushEngage push notifications in your React Native app in under 15 minutes.
- [React Native SDK Reference](https://www.pushengage.com/api/mobile-sdk/react-native/sdk-reference.md): Complete API reference for the PushEngage React Native SDK.
- [Attributes](https://www.pushengage.com/api/rest-api/attributes.md): Attributes are key-value pairs that allow you to store additional information about your subscribers. You can utilize attributes to segment your subscribers and send personalized notifications.
- [Create Drip Autoresponder](https://www.pushengage.com/api/rest-api/drip-autoresponder/create-auto-responder.md): Drip autoresponder is used to send a series of notifications to users depending on the criteria specified in the drip campaign. Drip campaign criteria are evaluated whenever a user subscribes to push notifications or when an existing user is added to a segment. A Drip campaign is initialized when a user satisfies the criteria specified in the Drip Autoresponder.
- [View Drip Autoresponder](https://www.pushengage.com/api/rest-api/drip-autoresponder/view-drip-autoresponder.md): This API endpoint returns a Drip Autoresponder campaign by id. The response includes the list of notifications in the Drip Autoresponder campaign.
- [View All Drip Autoresponders](https://www.pushengage.com/api/rest-api/drip-autoresponder/view-drip-autoresponders.md): This API endpoint provides a paginated list of all Drip Autoresponder campaigns. The campaigns are listed in descending order, with the most recently created campaigns appearing first.
- [E.164 Phone Format](https://www.pushengage.com/api/rest-api/e-164-phone-format.md): The E.164 phone format can be described as:
- [Track Event](https://www.pushengage.com/api/rest-api/events/track-event.md): Track a custom event for a subscriber. This is used to trigger workflows that listen for the specified event name.
- [Getting Started](https://www.pushengage.com/api/rest-api/getting-started.md): PushEngage offers a comprehensive set of REST APIs that facilitate integration with your existing systems. With these APIs, you can:
- [ISO 639 Language Codes](https://www.pushengage.com/api/rest-api/iso-639-language-codes.md): ISO 639 is a set of international standards that defines codes for the representation of names of languages. It is widely used across various fields to ensure consistency and accuracy in the identification of languages. The standard is maintained by the International Organization for Standardization (ISO) and helps facilitate the organization and exchange of linguistic data.
- [ISO 8601 Date Format](https://www.pushengage.com/api/rest-api/iso-8601-date-format.md): The format ISO 8601 Date can be described as:
- [Push Broadcast](https://www.pushengage.com/api/rest-api/notification/create-notification.md): A push notification is a message sent to a subscriber. A user visiting a website or application and coming across a request, asking them if they'd like to receive updates or notifications from that site. If the user agrees and gives permission, they become a subscriber. This means they've provided the necessary consent to receive push campaigns from that source. Therefore, whenever the website or application wants to convey information, updates, or any other messages, it can easily send a push campaign to its subscribers, ensuring their message is delivered.
- [View Push Broadcasts](https://www.pushengage.com/api/rest-api/notification/view-notifications.md): This endpoint lists all notifications associated with the site that have a sent status. The response is in JSON format.
- [Product Update](https://www.pushengage.com/api/rest-api/product-update.md): Product Update API is essential for updating product details utilized in features like price drop or back in stock alerts. If you're using these alert features, employ this API to communicate the latest product price and back in stock details. This enables timely notifications about any updates.
- [Add Subscriber to Segment](https://www.pushengage.com/api/rest-api/segment/add-subscriber-to-segment.md): This endpoint allows adding a subscriber to a segment using the subscriber_hash. This call accepts form-encoded request bodies and returns responses in JSON format.
- [Add Subscriber to Segment using Profile ID](https://www.pushengage.com/api/rest-api/segment/add-subscriber-to-segment-using-profileid.md): This endpoint allows you to add a subscriber to a segment using a profile ID. This call accepts form-encoded request bodies and returns responses in JSON format.
- [Create Segment](https://www.pushengage.com/api/rest-api/segment/create-segment.md): This endpoint facilitates the creation of a segment. This call accepts form-encoded request bodies and returns responses in JSON format.
- [Delete Segment](https://www.pushengage.com/api/rest-api/segment/delete-segment.md): This endpoint allows for the deletion of a segment. This call accepts form-encoded request bodies and returns responses in JSON format.
- [Understanding Segments](https://www.pushengage.com/api/rest-api/segment/intro.md): Segments allow you to categorize subscribers based on specific criteria, ensuring that you send tailored notifications that align with their preferences or behaviors. These criteria can range from personal details and activities to specific groups they've chosen.
- [View Segments](https://www.pushengage.com/api/rest-api/segment/view-segments.md): This endpoint retrieves a list of all segments created by users. The response is provided in JSON format.
- [Understanding Subscribers](https://www.pushengage.com/api/rest-api/subscriber/intro.md): A subscriber is an individual who has given explicit permission to receive notifications from a website or application. Picture a user navigating a site or app, presented with a request to receive updates or alerts. Once the user consents, they transition from just a visitor to a subscriber. This signifies their interest and agreement to be updated, allowing the platform to communicate directly with them through notifications.
- [Subscriber Analytics](https://www.pushengage.com/api/rest-api/subscriber/subscriber-analytics.md): The subscriber analytics summary provides stats on active subscribers for the entire site, breaking down the distribution of active subscribers across various dimensions, including categories like city, country, state, browser, and device. The response is in JSON format.
- [Subscriber Status](https://www.pushengage.com/api/rest-api/subscriber/subscriber-status.md): A subscriber is a user who has opted in to receive notifications from your website. This endpoint determines whether a subscriber is active, accepts form-encoded request bodies, and returns the response in JSON format.
- [Summary Analytics](https://www.pushengage.com/api/rest-api/summary-analytics.md): This endpoint retrieves the analytics summary for a specified date range. The summary includes subscriber count, unsubscribe count, notifications sent, notifications viewed, notifications clicked, and the click-through rate (CTR). The response is in JSON format.
- [View Triggered Campaign](https://www.pushengage.com/api/rest-api/triggered-campaign/view-triggered-campaign.md): This API endpoint returns a paginated list of all Triggered campaigns. The campaigns are listed in descending order, with the most recently created campaigns appearing first.
- [View All Triggered Campaigns](https://www.pushengage.com/api/rest-api/triggered-campaign/view-triggered-campaigns.md): This API endpoint returns a paginated list of all Triggered campaigns. The campaigns are listed in descending order, with the most recently created campaigns appearing first.
- [W3C URL Format](https://www.pushengage.com/api/rest-api/w3c-url-format.md): A URL (Uniform Resource Locator) in the W3C (World Wide Web Consortium) format consists of several components:
- [Web SDK](https://www.pushengage.com/api/web-sdk.md): The Website SDK is the latest version of our client-side JavaScript library designed for browser environments. It enables push notifications on your website and is not intended for server-side use. Compatible with all major browsers, this library works on both HTTP and HTTPS sites and can easily be added to any website.
- [Web SDK](https://www.pushengage.com/api/web-sdk/web-SDK-v2.md): The Website SDK is the legacy version of our client-side JavaScript library designed for browser environments. It enables push notifications on your website and is not intended for server-side use. Compatible with all major browsers, this library works on both HTTP and HTTPS sites and can easily be added to any website.