Events API

API methods to manage Events

To track events triggered by users, call the /postEvent method from User Centric API.

createEvent

/createEvent

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

Creates an Event for the app.

Request Body

Name	Type	Description
auth*	string	API access token from Pushwoosh Control Panel.
application*	string	Pushwoosh application code.
name	string	Event name, 32 characters max.
description	string	Event description, 64 characters max.
eventAttributes	array	Event attributes array.
trackRevenue	boolean	See Track Event Revenue section of https://www.pushwoosh.com/docs/events.

200

{
    "status_code": 200,
    "status_message": "OK",
    "response": {
        "event": 351 // Created Event Id
    }
}

{
  "request": {
    "auth":"yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // required, Pushwoosh application code
    "name": "BasketOpen", // required, 32 characters max. Event name. 
    "description": "Open basket page", // optional, 64 characters max. Event description. 
    "eventAttributes": [ // optional, event attributes array      
        {
            "type": 3, // Attribute type. Values: 1 - integer, 2 - string, 3 - list, 4 - date. 5 - boolean, 6 - price.  
            "name": "products" // 64 characters max. Attribute name 
        },
        {
            "type": 5,
            "name": "delivery"
        }
    ],
    "trackRevenue": false // optional, @see Track Event Revenue on https://www.pushwoosh.com/docs/events
  }
}

Response:

200	200	Event successfully created
200	210	Argument error. See status_message for more info
200	403	Permissions error (for example, when Events limit is exceeded)
200	404	Resource not found
400	N/A	Malformed request string
500	500	Internal error