User Centric API
API methods to manage users
post
https://cp.pushwoosh.com/json/1.3
/registerUser
/registerUser
Can be used later in
/createMessage API call (the users parameter).
This is normal to call this function before you have the push token and before /registerDevice call.Example
{
"request": {
"userId": "user_3078a", // optional, string. If empty, use hwid
"application": "XXXXX-XXXXX", // required, Pushwoosh application code
"hwid": "8f65b16df378e7a6bece9614e1530fb2", // required, hardware device ID
"tz_offset": -2917, // optional, timezone offset in seconds
"device_type": 3 // optional, device type, see /registerDevice for device types
}
}
post
https://cp.pushwoosh.com/json/1.3
/postEvent
/postEvent
The event's name in the request must match the event name in Pushwoosh Control Panel. Note that "attributes" property may be empty (but not omitted) in case the event has no attributes.
Example
{
"request":{
"hwid": "8f65b16df378e7a6bece9614e1530fb2", // required. Hardware device ID used in a /registerDevice request. Can be used along with an userId to identify a user who has triggered an event.
"application": "XXXXX-XXXXX", // required, Pushwoosh application code
"event": "activityCompleted", // required, event name exactly as created in Pushwoosh Control Panel
"attributes": { // required. Leave empty if no attributes need to be passed.
"login": "facebook",
"success": "yes",
"internet": "wifi",
...
},
"timestampUTC": 1435228403, // optional, timestamp in UTC
"timestampCurrent": 1435253603, // optional, timestamp in local time
"userId": "[email protected]", // required, a user id which is used for identification of users on multiple devices. Can be replaced by or used along with an HWID.
"device_type": 1 // optional
}
}
Last modified 3mo ago