User Centric API

API methods to manage users

registerUser

/registerUser

POST https://api.pushwoosh.com/json/1.3/registerUser

Associates external User ID with a specified device.

Request Body

Name	Type	Description
userId	string	User ID to associate with a device. If empty, use hwid.
application*	string	Pushwoosh application code.
hwid*	string	Pushwoosh HWID
tz_offset	integer	Timezone offset in seconds for the device.
device_type	integer	Device type. See possible values in /registerDevice.

200

{
  "status_code": 200, 
  "status_message": "OK",
  "response":null
}

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
      }
    }

For emails, call /registerEmailUser.

postEvent

/postEvent

POST https://api.pushwoosh.com/json/1.3/postEvent

Calls the event within the app.

Request Body

Name	Type	Description
hwid*	string	Hardware device ID used in a /registerDevice request. Can be used along with 'userId' to identify a user who has triggered an event.
application*	string	Pushwoosh application code.
event*	string	Event name exactly as created in Pushwoosh Control Panel.
attributes*	object	JSON object with the event attributes. Leave it empty if no attributes need to be passed.
timestampUTC	integer	Timestamp in UTC.
timestampCurrent	integer	Timestamp in local time.
userId*	string	User ID associated with a user who has triggered the event. Can be replaced by or used along with an HWID.
device_type	integer	See possible values in /registerDevice method.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "code": "61BC9-84DD0"
  }
}

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": "[e-mail]", // 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
   }
}