API at a glance

Description: This API allows you to send an event from your server or use JavaScript events to call the API. Events track user actions and behaviors on your platform.

Authorization: Basic encoded_value

Things to know before you start

• Required identifier fields: Ensure that you provide values for at least one of the following fields: customer_id, event, device_id, cookie or email.
• Best practice: If possible, provide values for more than one of these identifier fields.
• Anonymous users: For anonymous users, specify at least the value for the cookie.
• Event naming rules: Ensure that the event name does not contain periods (.), whitespaces, is not a numeric value, and contains no more than 64 characters.
• Mobile apps: If you use the event API to identify a user from a mobile app, ensure that you also include device_id and device_token parameters. However, we recommend using Blueshift's SDK for mobile apps. See Android SDK and iOS SDK.
• Use case: Best for tracking user interactions, behaviors, and custom events from your server or web application.

Request parameters

Example requests & responses

curl --request POST \
     --url https://api.getblueshift.com/api/v1/event \
     --header 'accept: application/json' \
     --header 'authorization: Basic <YOUR_EVENT_API_KEY>' \
     --header 'content-type: application/json' \
     --data '{
       "customer_id": "812123",
       "event": "identify",
       "email": "[email protected]",
       "device_type": "ios",
       "device_id": "8abe3faa-d48d-4e4a-00ca-beae01f1c987",
       "ip": "192.0.2.1",
       "subscription_groups": [
         {
           "id": "newsletter",
           "subscribed": true
         },
         {
           "id": "weekly_promo",
           "subscribed": false
         }
       ]
     }'

{
  "status": "OK"
}