The event API methods are used to push in realtime events similar to the eventHit methods found in the web and mobile SDKs. This allows users to trigger campaigns/workflows based on events that happen outside of sites or Apps. This is useful for triggering actions based on events that occur on backend systems.
N.B. the external API cannot be used to trigger onsite or in-app campaigns.
- Hit/Event: Used to push a single realtime event
- Hit/Events: Used to push batch of realtime events [NB disabled by default and will return 405,
majority of users have no use case for the batch realtime event endpoint]
Hit/Event
Used to send a realtime event to xtremepush when an event occurs on a backend system "sign_up", "purchase" etc.
api/external/hit/event
| Parameter | Description |
|---|---|
| apptoken |
Your App token |
| user_id |
Your external user ID. If a user with such user ID doesn't exist it will be automatically created. |
| user_attributes |
Key-value array of user attributes. These attributes will be updated before executing any event-triggered campaign. This is useful when the campaign depends on one of the user attributes, such as email address or first name. |
| event |
Event name |
| value |
Can be: |
Example
curl -X POST -d '{
"apptoken": YOUR_APPTOKEN,
"user_id": 12345,
"user_attributes": {
"email": "john@doe.com",
"first_name": "John"
},
"event":"purchase",
"value":{
"product_name":"Some Product",
"price":100
}
}' https://external-api.xtremepush.com/api/external/hit/event
Hit/Events
Used to push batch of realtime events to xtremepush when a batch of events occurs on a backend.
NB disabled by default and will return 405, majority of users have no use case for the batch realtime event endpoint. Please contact the support to enable this API.
Comments
0 comments
Article is closed for comments.