SmartPush now supports Open API integration that allows merchants to report user data and custom events from external systems (e.g., third-party CRM, custom-built websites, or other platforms).
By connecting your external data sources to SmartPush, you can:
- Trigger automations based on custom events;
- Segment audiences using custom attributes and event filters;
- Conduct cross-channel precision marketing driven by integrated data.
|
Note:
|
In This Article
Why is Smartpush API Matters
Many merchants operate multiple data systems: CRM, self-built websites, or external marketing tools. Without integration, these data remain isolated.
The SmartPush Open API enables you to consolidate multi-channel data into one SmartPush workspace, making it possible to:
Run automation flows triggered by custom business events;
Filter and analyze customers by imported data attributes;
Gain deeper audience insights for personalized marketing.
Use Cases
Many merchants operate multiple data systems: CRM, self-built websites, or external marketing tools. Without integration, these data remain isolated.
The SmartPush Open API enables you to consolidate multi-channel data into one SmartPush workspace, making it possible to:
Run automation flows triggered by custom business events;
Filter and analyze customers by imported data attributes;
Gain deeper audience insights for personalized marketing.
| Scenario | Description |
| 1. Add developer authorization | The store owner grants “Developer” role access to a developer account. The developer retrieves the API Token in SmartPush > Settings > API. |
| 2. Add custom user attributes | Developers use Profile API to create or update contact information and add new user attributes (e.g., membership tier, source platform). |
| 3. Add custom metrics and event attributes | Developers use Custom Metric API to create custom events and event properties (e.g., webinar registration, offline purchase). |
| 4. Filter custom user attributes | All authorized users can use these attributes in Segments to build audiences for email, SMS, or automation campaigns. |
| 5. Automate marketing based on custom events | Use reported events as triggers in Automations, with user attributes as additional conditions to build high-precision workflows. |
For Example:
A brand with a self-built site imports user actions from its own platform into SmartPush, enabling tailored post-purchase messaging.
A merchant integrates external behavioral data (e.g., app usage or event participation) and uses SmartPush to send targeted follow-up campaigns.
How to Set Up and Use SmartPush Open API
Step 1. Authorize a Developer Account
Go to SmartPush > Store Management > Store authorization management > Add authorized user.
Assign the Developer role to the developer account.
In SmartPush > Settings > API, view and copy the API Token.
| Important: Only store owners and developers can access the token. Other roles will see a permission warning. |
Step 2. Report Contacts and Attributes via Profile API
Endpoint: POST /createContact
Purpose: Create or update contact identity and attributes.
Supported field types: String, Integer, Float, Boolean, Date
Naming rules: email is case-insensitive; other fields are case-sensitive
You can define up to 20 custom attributes per store (prefixed with cus_)
| Important: Sensitive personal fields (e.g., name, address, phone, ID) are encrypted automatically. |
Step 3. Report Custom Events via Custom Metric API
Endpoint: POST /createCustomMetric
Purpose: Create new event types and event attributes for tracking.
Up to 50 custom events per store
Each event supports up to 20 event attributes
Duplicate EventCode will be rejected
Step 4. View and Manage Data in SmartPush
In Smartpush > Contacts,
Access custom user attributes under Custom User Attributes Management.
Filter audiences by custom fields in Segments > Basic Attributes > Custom Attributes.
View API tags under Segments > Others > API Tags.
In Smartpush > Metrics,
Find API-reported events under the new API category.
Check event status (Pending / Syncing / Paused).
Edit or delete unused events and attributes.
In Smartpush > Automations
Choose API Trigger as the entry event.
Add filters based on reported user or event attributes.
Example: Trigger an EDM when an imported “Offline Purchase” event occurs.
Notes & Limitations
Each store can add 20 custom user attributes and 50 custom events.
Deleted attributes or events will automatically be removed from Segments and Automations that use them.
Data is only stored in SmartPush and does not sync back to your main store contact list.
To ensure privacy, SmartPush encrypts all PII fields (email, phone, address, etc.).
Comments