PUSH API
Scalable Transactional Messaging and Automation
The PUSH API section enables full integration of your system with the MessageFlow infrastructure. This solution is dedicated to handling transactional notifications (e.g., order statuses, 2FA codes) and executing automated communication scenarios directly from the code, bypassing the visual dashboard interface.
Key PUSH API Capabilities
Transactional Sending: Rapid execution of single, time-critical messages (e.g., 2FA codes, security alerts, order statuses) sent in response to an event.
Full Automation: Real-time notification triggering in response to events within your system (trigger-based messaging).
Logs & Search in Panel: Even though sending is done programmatically, you have full insight into event history within the panel interface. The built-in search tool allows you to quickly locate a specific dispatch and verify its status, significantly speeding up ticket handling (Customer Support) and error verification.
Webhooks & Reporting: The ability to receive delivery status reports (DLR) directly to your system via a callback/webhook mechanism.
Addressing: Precise user targeting using a unique Device Token (a character string generated by the app that identifies the device).
Best Practice: Bulk Sends The API is optimized for fast transactional notifications (1:1). For high-volume marketing campaigns (bulk), we recommend using the Campaigns module in the panel. It features dedicated throughput management mechanisms that guarantee stability and delivery speed for large audience bases.
How does it work?
Communication takes place via secure HTTPS requests. Your system sends a payload (content + recipients) to MessageFlow, which validates the request and routes it to the appropriate gateways (FCM for Android / APNs for iOS).
Method:
POSTEndpoint:
/v2.1/pushRequired parameters: In the request
body, you must pass an array of device tokens (device_tokens) and the message content.
Developer Documentation A detailed description of methods, JSON structure, error codes, and implementation examples (cURL, PHP, Python, Java) can be found in our documentation.
Technical Specification
Please note that character limits (title/content) and image formats apply to API sends as well. The full specification can be found in the Overview tab.
Last updated