Use this endpoint to send an update to or to alert customers about topics that they have subscribed to.
API at a glance
Description: Send updates or alerts to customers about topics they have subscribed to. Triggers notifications for subscribed users when new content or events are available for their interests.
Authentication & testing
Testing the API on this page
How to try it here
- Use your User API Key as the Username (leave Password blank).
- Select the appropriate API endpoint based on your Blueshift region.
- Enter the necessary parameters and click Try It to run the request.
Authentication using Base64 encoding
Note for developers
API requests require authentication using HTTP Basic Authentication with an API key.
The API key serves as the username, while the password field should be left empty.
The format to encode is: your_api_key: (note the trailing colon).
This string must be Base64-encoded and included in the request's Authorization header as follows:
Authorization: Basic encoded_valueYou can generate the encoded value using a trusted Base64 encoder.
Postman collection
Try it with Postman: Explore the API using Blueshift's Postman collection.
Things to know before you start
- Topic-based alerts: Only customers subscribed to the specified topic will receive the alert.
- Custom metadata: Use the
metadataparameter to add custom attributes like city, discount, coupon code, match details, or any contextual information about the update. - Author required: The author's email must be provided to identify who is sending the alert.
- Event name: Choose a descriptive event name to track different types of alerts (e.g.,
interest_news_alert,interest_price_drop,interest_live_event).
Request parameters
Check out the request parameters
Body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
event | string | ✅ Yes | Name of the event for this alert. Example: interest_news_alert |
topic | string | ✅ Yes | Topic that customers have subscribed to. Example: sports |
author | string | ✅ Yes | Email address of the alert author. Example: [email protected] |
metadata | object | ✅ Yes | Custom attributes with information about the update. Example: {"match": "Lakers vs Warriors"} |
NoteUse the
metadataparameter to add custom attributes to provide more information about the update. For example, city, discount, coupon code, and so on.
Example requests & responses
Send alert for sports topic
POST /api/v1/interests/alert{
"event": "interest_news_alert",
"topic": "sports",
"author": "[email protected]",
"metadata": {
"live_match_today": true,
"teams": "Lakers vs Warriors",
"start_time": "7:30 PM EST"
}
}{
"success": true
}Send price drop alert
POST /api/v1/interests/alert{
"event": "interest_price_drop",
"topic": "electronics",
"author": "[email protected]",
"metadata": {
"product": "Laptop",
"old_price": 999.99,
"new_price": 799.99,
"discount_percent": 20,
"coupon_code": "SAVE20"
}
}{
"success": true
}Error responses
400 Bad Request - Missing topic
{
"errors": [
{
"topic": "can't be blank"
}
]
}Unprocessable Entity - Some/all of the products have invalid data, please check the response for more information on.
Rate limit exceeded - Too many requests
Internal Server Error - Please contact blueshift for more information
Service unavailable, please retry - Bad Gateway, re-try with exponential backoff
Service unavailable, please retry - Service Unavailable, re-try with exponential backoff
Service unavailable, please retry - Gateway Timeout, please re-try with exponential backoff