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.
- Event: Used to push a single realtime event
- 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]
Event
Used to send a realtime event to xtremepush when an event occurs on a backend system "user.registration.approved", "user.ticket.scanned" etc.
URL
api/external/hit/event
Parameters
| Parameter | Description |
|---|---|
| apptoken | Your App token |
| ID Type |
An id used to identify the user here is the list of available id types:
Used as follows; "user_id": "12345" |
| event | The event being pushed for example "event":"user.registration.approved", this is a required param. |
| value | The value associated with this event example "value":"true", this is an optional param. |
Example
Push in a single event for a specific user:
curl -X POST -d '{ "apptoken": "YOUR_APPTOKEN","user_id":"20","event":"user.registration.approved"}' https://external-api.xtremepush.com/api/external/hit/event
Events [NB disabled by default and will return 405, majority of users have no use case for the batch realtime event endpoint]
Used to push batch of realtime events to xtremepush when a batch of events occurs on a backend system for example an array of "user.registration.approved" or "user.ticket.scanned" events..
URL
api/external/hit/events
Parameters
| Parameter | Description |
|---|---|
| apptoken | Your App token |
| events |
The array of events being pushed for example "events":[{ , this is a required param. The params in the individual events are described below. |
| ID Type |
An id used to identify the user here is the list of available id types:
Used as follows; "user_id": "12345" |
| event | An individual event being pushed in, in the array for example "event":"user.registration.approved", this is a required param. |
| value | The value associated with an individual event in the array example "value":"true", this is an optional param. |
Example
Push in a group of events for a specific user:
curl -X POST -d '{ "apptoken": "YOUR_APPTOKEN","tags":[{"user_id":"20","tag":"user.registration.approved","value":"true"},{"user_id":"21","event":"user.registration.approved","value":"true"}]}' https://external-api.xtremepush.com/api/external/hit/tags
Comments
0 comments
Article is closed for comments.