Guides

To ensure that our API is healthy, we build everything with our APIs, even our own web platforms. This helps us to maintain our API working all the time and provide every kind of information needed through our API.

To better provide a working flow of usage with our API, some resources are grouped in guides to better explain how they work and how you can extract most of them. The best way to understand how our products connect with each other and how you can better integrate them to achieve your results is through our API documentation and understanding all of the possibilities each resource provides.

We have documentation for root modules (these are your main resources to manage data), and, most of them have submodules attached that allows you to connect two different root modules (for example, we have event, person and eventPerson, the third being a connection between a person and an event). A full list of modules are presented to your left and submodules are indented accordingly.

For each root module, there are four basic operations, represented by your well known CRUD (Create, Read, Update and Delete). We decided to swap some operation names to make it more intuitive. Those are the following operations:

  • create: creates an object;
  • edit: edits an object;
  • remove: removes an object;
  • find: searches for objects;
  • get: gather an object;

For submodules, we still have those basic operations, but with different names. As submodules are relations between two different root modules, we decided to use a connection/relation approach when creating those names:

  • bind: creates a connection;
  • operate: edits a connection;
  • dismiss: removes a connection;
  • find: searches for connections;
  • get: gather a connection;

Finally, we remind you that we are here to help. If you have any questions regarding a specific guide or you want to suggest improvements in our documentation, please send an email to developer@inevent.com so we try to assist you with your need/suggestion with love.

Check-in

For data integration with InEvent for check-in, it is necessary to integrate all read and write aspects of new attendees, in addition to inform new label printing and read accesses to our access control.

The registration and verification of new attendees occurs through methods available on event.person. To create a new attendee, we have some methods on event.person.bind and to read some attendees, on event.person.find or event.person.get. All of these returns relevant informations about the registration process.

At the moment of the printing, it is important to inform new prints on event.person.print. When retrieving information from our APIs, there will be a count of printed labels already printed (it is possible to limit the amount of labels each attendee is allowed to print). To obtain a cache of information prior to check-in, you may use event.person.find with limit=500000 to obtain a simplified representation of attendees data.

All of our generated QR Codes are encrypted inside the qrCode key. They are the same inside the application and on emails sent to attendees. You may reduce the size of this QR Code as well. For security purposes these formats cannot be modified by any third-party, so if you need to use a qrCode, you must use the one available in our platform.

Deep linking

To send information to our mobile app, it is possible to use deep linking, a technique that allows sending data between applications, data that will be parsed during the app boot process. InEvent uses this technique, allowing you to define during the initialization of our mobile app the user tokenID, the selected event and more. For iOS apps, the official URL is:

inevent://

Currently we accept the following parameters: tokenID, eventID, memberID and name. A good example is, with a given eventID of 1, would be:

inevent://?eventID=1

Some specific services, like Gmail or Hotmail do not recognize our deep linking url as valid urls (since inevent is not a valid protocol). So, to achieve better communication with those services, you may use a different protocol and format to communicate with our applications:

https://app.inevent.com/appURL.php

All parameters specified above sent via query string GET will be replaced automatically with the previous format shown firstly.

Advertising

It is really usual for events to have several sponsors, companies that are interested in displaying their brand during the event. You can create advertisement in our platform for each sponsor, determining their priority and defining if it is a fullscreen ad or a footer ad. These ads are displayed right after the app is opened, or every 10 minutes of direct usage.

To create a new ad, firstly you need to create a sponsor using sponsor.create. With the sponsor created, you now have a sponsorID, an ID that uniquely identifies a sponsor. To create a new ad for this sponsor, you must use ad.create. This ad may have different priorities (weight), that will be used to determine when this ad must be shown. It is possible as well to create a main ad (an ad that displays on event information section of the app). The default format is splash. To modify your ad, you must use ad.edit.

How to

To start using InEvent API, please follow our documentation on the left. Below we have an example that will be disassembled to further explain how it works.

API URL

https://app.inevent.com/api/

Example of documentation

person.signIn(username, password)

Signs in and returns a tokenID (60-byte string) in case the request has been successful.

usernameGET : person username

passwordPOST : password

Parameters are automatically encoded and sent via HTTPS:

https://app.inevent.com/api/?action=person.signIn&username=Email

There are three sections: header, parameters and return. Each of them are explained separately below:

  • The header (person.signIn) represents the API call, composed of a namespace (person) -- a resource -- and its method (signIn). This header must be send via query string QUERY in the URL with key action.
  • The parameters username and password are explained by clicking on the icon %s and how they should be sent, either via query string QUERY or via body BODY encoded as application/x-www-form-urlencoded
  • The return displays which kind of data will be returned.

Marking

Each method presents the following marks to visualy indicate a specific meaning:

  • *: optional parameters;
  • bold: required parameters;
  • italic: return parameters;
  • understroke: endpoint;
  • regular: parameter value;
  • subscript: method of transference.

Tools

For each existing method, it is possible to use inline tools to obtain the following information:

  • : Inline debugger to easily test your code, send additional parameters and obtain your request response.;
  • : Sandbox testing, you just need to inform sandboxGET on your request with value of 1.

Security

The InEvent API utilizes a hybrid RPC-REST with 128bit encrypted connection certified by PositiveSSL CA2.

Return

The returned data may come in different formats, you just need to specify a custom format using the formatGET parameter. The default format is json.

  • json: a json file with count and data as default root elements;
  • excel: a Excel file, with content type of
    Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.

Activity

During an event there are many activities which start and take part in specific time periods. Each one receives an identifier allowing to access their information or receive changes on its channels.

Models

{
    "count": 1,
    "data": [
        {
            "activityID": "14",
            "eventID": "1",
            "placeID": "0",
            "name": "Opening",
            "description": "Kits delivery",
            "latitude": "-22.0062",
            "longitude": "-47.8975",
            "location": "",
            "dateBegin": "1376908200",
            "dateEnd": "1376913600",
            "capacity": "0",
            "general": "1",
            "highlight": "0",
            "personID": "0",
            "approved": "-1",
            "priori": "0",
            "stream": "",
            "lockOperations": "",
            "speakers": [],
            "tags": []
        }
    ]
}
{
    "approved": {
        "-1": "not registered",
        "0": "registered and not approved",
        "1": "registered and approved"
    }
}

Push Notification

activity/create

_event

Informs activity activityID creation at event eventID.

{
    "activityID": "integer"
}

activity/edit

_event

Informs activity activityID update at event eventID.

{
    "activityID": "integer"
}

activity/remove

_event

Informs activity activityID removal from event eventID.

{
    "activityID": "integer"
}

Methods

activity.create

( tokenID, eventID, name, *description, *location, *dateBegin, *dateEnd, *capacity )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=activity.create&tokenID=&eventID=" \   -d "name="
$response = InEvent\Activity::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => ""
]);

Creates an activity named name at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : activity name

*descriptionBODY : activity description

*locationBODY : activity location

*dateBeginBODY : activity begin date

*dateEndBODY : activity end date

*capacityBODY : maximum number of people

( tokenID, eventID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=activity.create&tokenID=&eventID=" \   -d "path="
$response = InEvent\Activity::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "path" => ""
]);

Creates multiple activities at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

pathBODY : file path

activity.edit

( tokenID, activityID, key, value, *push )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=activity.edit&tokenID=&activityID=&key=" \   -d "value="
$response = InEvent\Activity::edit($client, [
  "tokenID" => "",
  "activityID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

keyQUERY : field name

{
    "placeID": "place identifier",
    "name": "activity name",
    "description": "activity description",
    "latitude": "activity latitude",
    "longitude": "activity longitude",
    "location": "activity location (address)",
    "dateBegin": "activity begin date",
    "dateEnd": "activity end date",
    "capacity": "maximum number of approved people",
    "oversize": "maximum number of people attending",
    "general": "automatic inscription?",
    "highlight": "activity with highlight?",
    "stream": "streaming link",
    "lockOperations": "member can enroll or dismiss from activity"
}

valueBODY : field value

{
    "placeID": "integer",
    "name": "string",
    "description": "string",
    "latitude": "integer",
    "longitude": "integer",
    "location": "string",
    "dateBegin": "timestamp",
    "dateEnd": "timestamp",
    "capacity": "integer",
    "oversize": "integer",
    "general": "bit",
    "highlight": "bit",
    "stream": "string",
    "lockOperations": "bit"
}

*pushQUERY : push notification send for editing

activity.remove

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.remove&tokenID=&activityID="
$response = InEvent\Activity::remove($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Removes activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

activity.find

( tokenID, eventID, selection, personID, *dateBegin, *dateEnd, *paginated )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.find&tokenID=&eventID=&selection=&personID="
$response = InEvent\Activity::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => "",
  "personID" => ""
]);

Returns all activities from person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : activity registered

{
    "all": "all activities",
    "enrolled": "events registered",
    "available": "events not registered"
}

personIDQUERY : person identifier

*dateBeginQUERY : begin date

*dateEndQUERY : end date

*paginatedQUERY : will return a paginated response

( tokenID, eventID, selection, listID, *dateBegin, *dateEnd )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.find&tokenID=&eventID=&selection=&listID="
$response = InEvent\Activity::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => "",
  "listID" => ""
]);

Returns all activities containing list listID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : registered in activity

{
    "all": "all activities",
    "enrolled": "events registered",
    "available": "events not registered"
}

listIDQUERY : list identifier

*dateBeginQUERY : begin date

*dateEndQUERY : end date

( tokenID, eventID, selection, *dateBegin, *dateEnd )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.find&tokenID=&eventID=&selection="
$response = InEvent\Activity::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Returns all activities from event eventID to person tokenID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : activity registration

{
    "all": "all activities",
    "all+meeting": "all activities + meetings",
    "approved": "approved registration",
    "enrolled": "registered activities",
    "enrolled+meeting": "registered activities + meetings",
    "available": "activities not registered",
    "denied": "registration rejected",
    "paid": "registration paid",
    "present": "person attending"
}

*dateBeginQUERY : begin date

*dateEndQUERY : end date

( eventID, *dateBegin, *dateEnd, *invite )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.findHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=activity.find&eventID=" \   -d ""
$response = InEvent\Activity::find($client, [
  "eventID" => ""
], [

]);

Returns all activities from event eventID if the event is public and visible.

eventIDQUERY : event identifier

*dateBeginQUERY : begin date

*dateEndQUERY : end date

*inviteBODY : invite information

( eventID, *dateBegin, *dateEnd )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.find&eventID="
$response = InEvent\Activity::find($client, [
  "eventID" => ""
]);

Returns all activities from event eventID if the event is public and visible.

eventIDQUERY : event identifier

*dateBeginQUERY : begin date

*dateEndQUERY : end date

activity.get

( tokenID, activityID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.get&tokenID=&activityID=&personID="
$response = InEvent\Activity::get($client, [
  "tokenID" => "",
  "activityID" => "",
  "personID" => ""
]);

Returns activity activityID for person personID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

personIDQUERY : person identifier

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.get&tokenID=&activityID="
$response = InEvent\Activity::get($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns activity activityID, informing if person tokenID is registered.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

( activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.get&activityID="
$response = InEvent\Activity::get($client, [
  "activityID" => ""
]);

Returns activity activityID.

activityIDQUERY : activity identifier

activity.getDays

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.getDaysHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.getDays&tokenID=&eventID="
$response = InEvent\Activity::getDays($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns activity days for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

activity.copy

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.copyHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.copy&tokenID=&activityID="
$response = InEvent\Activity::copy($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Copies activity activityID on the same origin event.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

activity.delay

( tokenID, activityID, minutes, subsequent )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.delayHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.delay&tokenID=&activityID=&minutes=&subsequent="
$response = InEvent\Activity::delay($client, [
  "tokenID" => "",
  "activityID" => "",
  "minutes" => "",
  "subsequent" => ""
]);

Delays activity activityID and, opcionally subsequent, every following activities in minutes minutes.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

minutesQUERY : minutes of delay

subsequentQUERY : following activities?

Activity chains

At the event, several activities can be chained, i.e. we can create an id to chain activities and block users to register in more than one chained activity.

Models

{
    "count": 1,
    "data": [
        {
            "chainID": "1",
            "activityID": "330"
        }
    ]
}

Methods

activity.chain.bind

( tokenID, chainID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.chain.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.chain.bind&tokenID=&chainID=&activityID="
$response = InEvent\Activity.chain::bind($client, [
  "tokenID" => "",
  "chainID" => "",
  "activityID" => ""
]);

Requests activity activityID chaining at chain chainID.

tokenIDQUERY : token identifier

chainIDQUERY : chain identifier

activityIDQUERY : activity identifier

activity.chain.dismiss

( tokenID, chainID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.chain.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.chain.dismiss&tokenID=&chainID=&activityID="
$response = InEvent\Activity.chain::dismiss($client, [
  "tokenID" => "",
  "chainID" => "",
  "activityID" => ""
]);

Removes activity activityID from chain chainID.

tokenIDQUERY : token identifier

chainIDQUERY : chain identifier

activityIDQUERY : activity identifier

activity.chain.find

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.chain.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.chain.find&tokenID=&activityID="
$response = InEvent\Activity.chain::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns all chains from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

activity.chain.findChainedActivities

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.chain.findChainedActivitiesHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.chain.findChainedActivities&tokenID=&activityID="
$response = InEvent\Activity.chain::findChainedActivities($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns all activities from all chains for activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

Activity lists

Activities can be restricted to people part of a single or several lists.

Models

{
    "count": 1,
    "data": [
        {
            "activityID": "330",
            "listID": "1"
        }
    ]
}

Methods

activity.list.bind

( tokenID, listID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.list.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.list.bind&tokenID=&listID=&activityID="
$response = InEvent\Activity.list::bind($client, [
  "tokenID" => "",
  "listID" => "",
  "activityID" => ""
]);

Requests list listID creation on activity activityID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

activityIDQUERY : activity identifier

activity.list.dismiss

( tokenID, listID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.list.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.list.dismiss&tokenID=&listID=&activityID="
$response = InEvent\Activity.list::dismiss($client, [
  "tokenID" => "",
  "listID" => "",
  "activityID" => ""
]);

Removes list listID from activity activityID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

activityIDQUERY : activity identifier

activity.list.find

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.list.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.list.find&tokenID=&activityID="
$response = InEvent\Activity.list::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns all lists from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

Activity attendees

Inside of an activity, there are several participants who can access its data and receive authorization to interact on it. Besides of knowing who's registered in the activity, we have access to the waiting list and the registration order.

Models

{
    "count": 1,
    "data": [
        {
            "personID": "1",
            "position": "330",
            "approved": "1",
            "paid": "0",
            "present": "0",
            "priori": "1",
            "rating": "0",
            "enrollmentID": "1"
        }
    ]
}
{
    "approved": {
        "-1": "not registered",
        "0": "registered and not approved",
        "1": "registered and approved"
    }
}

Methods

activity.person.bind

( tokenID, activityID, name, email, *bypassWebhook )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=activity.person.bind&tokenID=&activityID=" \   -d "name=&email="
$response = InEvent\Activity.person::bind($client, [
  "tokenID" => "",
  "activityID" => ""
], [
  "name" => "",
  "email" => ""
]);

Requests person with name name and email email to join activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

nameBODY : person name

emailBODY : person email

*bypassWebhookQUERY : if there's a registered webhook, a bypass is performed

( tokenID, activityID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.person.bind&tokenID=&activityID=&personID="
$response = InEvent\Activity.person::bind($client, [
  "tokenID" => "",
  "activityID" => "",
  "personID" => ""
]);

Requests person personID to join activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

personIDQUERY : person identifier

( tokenID, activityID, personID, *bypassWebhook )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.person.bind&tokenID=&activityID=&personID="
$response = InEvent\Activity.person::bind($client, [
  "tokenID" => "",
  "activityID" => "",
  "personID" => ""
]);

Requests person personID to join activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

personIDQUERY : person identifier

*bypassWebhookQUERY : if there's a registered webhook, a bypass is performed

( tokenID, activityID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=activity.person.bind&tokenID=&activityID=" \   -d "path="
$response = InEvent\Activity.person::bind($client, [
  "tokenID" => "",
  "activityID" => ""
], [
  "path" => ""
]);

Requests multiple people to join activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

pathBODY : file path

( tokenID, eventID, content, *bypassWebhook )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=activity.person.bind&tokenID=&eventID=" \   -d "content="
$response = InEvent\Activity.person::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Request multiple people to join multiple activities through content.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : json formatted as [{activityID, personID}]

*bypassWebhookQUERY : if there's a webhook registered, a bypass is performed

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.person.bind&tokenID=&activityID="
$response = InEvent\Activity.person::bind($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Requests person tokenID to join activity activityID. On this call is not possible to perform a webhook bypass.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

activity.person.operate

( tokenID, activityID, key, value, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.person.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=activity.person.operate&tokenID=&activityID=&key=&personID=" \   -d "value="
$response = InEvent\Activity.person::operate($client, [
  "tokenID" => "",
  "activityID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

Edits value value from field key for person personID at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

keyQUERY : element name

{
    "approved": "approval status",
    "paid": "payment made",
    "present": "attendance",
    "priori": "registration priority"
}

valueBODY : desired action

{
    "approved": "bit",
    "paid": "bit",
    "present": "bit",
    "priori": "bit"
}

personIDQUERY : person identifier

( tokenID, activityID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.person.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=activity.person.operate&tokenID=&activityID=&key=" \   -d "value="
$response = InEvent\Activity.person::operate($client, [
  "tokenID" => "",
  "activityID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key for person tokenID at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

keyQUERY : element name

{
    "priori": "registration priority"
}

valueBODY : desired action

{
    "priori": "bit"
}

activity.person.dismiss

( tokenID, activityID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.person.dismiss&tokenID=&activityID=&personID="
$response = InEvent\Activity.person::dismiss($client, [
  "tokenID" => "",
  "activityID" => "",
  "personID" => ""
]);

Requests person personID removal from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

personIDQUERY : person identifier

( tokenID, activityID, personID, *bypassWebhook )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.person.dismiss&tokenID=&activityID=&personID="
$response = InEvent\Activity.person::dismiss($client, [
  "tokenID" => "",
  "activityID" => "",
  "personID" => ""
]);

Requests person personID removal from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

personIDQUERY : person identifier

*bypassWebhookQUERY : if there's a webhook registered, a bypass is performed

( tokenID, eventID, content, *bypassWebhook )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=activity.person.dismiss&tokenID=&eventID=" \   -d "content="
$response = InEvent\Activity.person::dismiss($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Requests a multiple people removal from multiple activities through content.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : json formatted as [{activityID, personID}]

*bypassWebhookQUERY : if there's a webhook registered, a bypass is performed

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.person.dismiss&tokenID=&activityID="
$response = InEvent\Activity.person::dismiss($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Requests person tokenID removal from activity activityID. On this call is not possible to perform a webhook bypass.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

activity.person.find

( tokenID, activityID, selection, *order, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.person.find&tokenID=&activityID=&selection="
$response = InEvent\Activity.person::find($client, [
  "tokenID" => "",
  "activityID" => "",
  "selection" => ""
]);

Returns everyone in activity activityID, filtered by a selection selection and a order order.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

selectionQUERY : activity registration

{
    "all": "all activities",
    "approved": "registration approved",
    "denied": "registration rejected",
    "paid": "registration paid",
    "present": "person attending"
}

*orderQUERY : order based on the column

*queryQUERY : text for search

activity.person.get

( tokenID, activityID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.person.get&tokenID=&activityID=&personID="
$response = InEvent\Activity.person::get($client, [
  "tokenID" => "",
  "activityID" => "",
  "personID" => ""
]);

Returns details from person personID at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

personIDQUERY : person identifier

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.person.get&tokenID=&activityID="
$response = InEvent\Activity.person::get($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns details from person tokenID at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

activity.person.calculate

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.calculateHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.person.calculate&tokenID=&activityID="
$response = InEvent\Activity.person::calculate($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Calculates the number of participants from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

Activity speakers

In an activity it shows the speakers responsible for speaking on it.

Models

{
    "count": 1,
    "data": [
        {
            "speakerID": "1",
            "eventID": "1",
            "name": "Pedro Góes",
            "headline": "CEO @ InEvent",
            "description": "Company founder",
            "category": "Category",
            "image": "http:\/\/",
            "email": "email@email.com",
            "facebook": "http:\/\/",
            "linkedIn": "http:\/\/",
            "twitter": "http:\/\/"
        }
    ]
}

Methods

activity.speaker.bind

( tokenID, activityID, speakerID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.speaker.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.speaker.bind&tokenID=&activityID=&speakerID="
$response = InEvent\Activity.speaker::bind($client, [
  "tokenID" => "",
  "activityID" => "",
  "speakerID" => ""
]);

Adds speaker speakerID at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

speakerIDQUERY : speaker identifier

activity.speaker.dismiss

( tokenID, activityID, speakerID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.speaker.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.speaker.dismiss&tokenID=&activityID=&speakerID="
$response = InEvent\Activity.speaker::dismiss($client, [
  "tokenID" => "",
  "activityID" => "",
  "speakerID" => ""
]);

Removes speaker speakerID from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

speakerIDQUERY : speaker identifier

activity.speaker.find

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.speaker.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.speaker.find&tokenID=&activityID="
$response = InEvent\Activity.speaker::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns all speakers from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

( tokenID, speakerID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.speaker.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.speaker.find&tokenID=&speakerID="
$response = InEvent\Activity.speaker::find($client, [
  "tokenID" => "",
  "speakerID" => ""
]);

Returns all activities from speaker speakerID.

tokenIDQUERY : token identifier

speakerIDQUERY : speaker identifier

Activity sponsors

Inside an activity the sponsors will be present.

Models

{
    "count": 1,
    "data": [
        {
            "sponsorID": "1",
            "eventID": "1",
            "companyName": "InEvent",
            "name": "Pedro Góes",
            "telephone": "000-000-0000",
            "email": "email@email.com",
            "website": "www.email.com",
            "bio": "some history",
            "logo": "\/path\/to\/logo",
            "category": "gold"
        }
    ]
}

Methods

activity.sponsor.bind

( tokenID, activityID, sponsorID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.sponsor.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.sponsor.bind&tokenID=&activityID=&sponsorID="
$response = InEvent\Activity.sponsor::bind($client, [
  "tokenID" => "",
  "activityID" => "",
  "sponsorID" => ""
]);

Adds sponsor sponsorID at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

sponsorIDQUERY : sponsor identifier

activity.sponsor.dismiss

( tokenID, activityID, sponsorID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.sponsor.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.sponsor.dismiss&tokenID=&activityID=&sponsorID="
$response = InEvent\Activity.sponsor::dismiss($client, [
  "tokenID" => "",
  "activityID" => "",
  "sponsorID" => ""
]);

Removes sponsor sponsorID from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

sponsorIDQUERY : sponsor identifier

activity.sponsor.find

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.sponsor.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.sponsor.find&tokenID=&activityID="
$response = InEvent\Activity.sponsor::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns all sponsors from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

( tokenID, eventID, sponsorID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.sponsor.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.sponsor.find&tokenID=&eventID=&sponsorID="
$response = InEvent\Activity.sponsor::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "sponsorID" => ""
]);

Returns all activities from sponsor sponsorID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sponsorIDQUERY : sponsor identifier

Activity tags

Tags associated with the activities, creating options to identify the participants interest on activities.

Models

{
    "count": 1,
    "data": [
        {
            "activityID": "1",
            "tagID": "1300"
        }
    ]
}

Methods

activity.tag.bind

( tokenID, activityID, tagID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.tag.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.tag.bind&tokenID=&activityID=&tagID="
$response = InEvent\Activity.tag::bind($client, [
  "tokenID" => "",
  "activityID" => "",
  "tagID" => ""
]);

Adds tag tagID to activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

tagIDQUERY : tag identifier

activity.tag.dismiss

( tokenID, activityID, tagID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.tag.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.tag.dismiss&tokenID=&activityID=&tagID="
$response = InEvent\Activity.tag::dismiss($client, [
  "tokenID" => "",
  "activityID" => "",
  "tagID" => ""
]);

Removes tag tagID from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

tagIDQUERY : tag identifier

activity.tag.find

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.tag.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.tag.find&tokenID=&activityID="
$response = InEvent\Activity.tag::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns all activity activityID tags.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

( activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.tag.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=activity.tag.find&activityID="
$response = InEvent\Activity.tag::find($client, [
  "activityID" => ""
]);

Returns all activity activityID tags.

activityIDQUERY : activity identifier

Ad

It's common for an event having several sponsor, companies interested in disclosuring their brands throughout the event. Those communication instruments, ranging from the companies logos to complete advertising contents, are shown each time the application opens, one for each time this event happens.

Models

{
    "count": 1,
    "data": [
        {
            "adID": "1",
            "eventID": "1",
            "sponsorID": "0",
            "image": "uploads\/image.jpg",
            "link": "http:\/\/nytimes.com",
            "weight": "0",
            "main": "1",
            "splash": "1"
        }
    ]
}

Methods

ad.create

( tokenID, eventID, sponsorID, *type )

  • Info
  • Curl
  • PHP
POST /api/?action=ad.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=ad.create&tokenID=&eventID=&sponsorID=" \   -d ""
$response = InEvent\Ad::create($client, [
  "tokenID" => "",
  "eventID" => "",
  "sponsorID" => ""
], [

]);

Creates a new add associated with sponsor sponsorID for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sponsorIDQUERY : sponsor identifier

*typeBODY : ad type

ad.edit

( tokenID, adID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=ad.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=ad.edit&tokenID=&adID=&key=" \   -d "value="
$response = InEvent\Ad::edit($client, [
  "tokenID" => "",
  "adID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key at ad adID.

tokenIDQUERY : token identifier

adIDQUERY : ad identifier

keyQUERY : field name

{
    "sponsorID": "sponsor id",
    "image": "image url",
    "link": "destination url",
    "weight": "ad weight",
    "main": "main, one per event",
    "splash": "full screen"
}

valueBODY : field value

{
    "sponsorID": "integer",
    "image": "url",
    "link": "url",
    "weight": "1..10",
    "main": "bit",
    "splash": "bit"
}

ad.remove

( tokenID, adID )

  • Info
  • Curl
  • PHP
GET /api/?action=ad.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=ad.remove&tokenID=&adID="
$response = InEvent\Ad::remove($client, [
  "tokenID" => "",
  "adID" => ""
]);

Removes ad adID.

tokenIDQUERY : token identifier

adIDQUERY : ad identifier

ad.find

( eventID, sponsorID )

  • Info
  • Curl
  • PHP
GET /api/?action=ad.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=ad.find&eventID=&sponsorID="
$response = InEvent\Ad::find($client, [
  "eventID" => "",
  "sponsorID" => ""
]);

Returns all ads from sponsor sponsorID at event eventID.

eventIDQUERY : event identifier

sponsorIDQUERY : sponsor identifier

( eventID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=ad.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=ad.find&eventID=&selection="
$response = InEvent\Ad::find($client, [
  "eventID" => "",
  "selection" => ""
]);

Returns all ads from event eventID.

eventIDQUERY : event identifier

selectionQUERY : ad selection

{
    "all": "all ads",
    "live-app": "app ads",
    "virtual-lobby": "virtual lobby ads",
    "approved": "app ads approved"
}

Ally

Allies are professional contacts generated in convenient moments and added to a single list for future contacts. This list can be handle in different ways, even being exported to other means. Since the relation of two allies is bidirectional, people and allies are interchangeable ids.

Models

{
    "count": 1,
    "data": [
        {
            "personID": "1",
            "name": "Pedro Góes",
            "email": "email@email.com",
            "headline": "CEO @ InEvent",
            "image": "",
            "telephone": "000-000-0000",
            "city": "New York",
            "cpf": "",
            "facebookID": "2147483647",
            "linkedInID": "0"
        }
    ]
}

Methods

ally.create

( tokenID, allyID )

  • Info
  • Curl
  • PHP
GET /api/?action=ally.createHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=ally.create&tokenID=&allyID="
$response = InEvent\Ally::create($client, [
  "tokenID" => "",
  "allyID" => ""
]);

Ads a connection with person allyID.

tokenIDQUERY : token identifier

allyIDQUERY : person identifier

ally.remove

( tokenID, allyID )

  • Info
  • Curl
  • PHP
GET /api/?action=ally.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=ally.remove&tokenID=&allyID="
$response = InEvent\Ally::remove($client, [
  "tokenID" => "",
  "allyID" => ""
]);

Removes person allyID.

tokenIDQUERY : token identifier

allyIDQUERY : person identifier

ally.find

( tokenID, selection, *order )

  • Info
  • Curl
  • PHP
GET /api/?action=ally.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=ally.find&tokenID=&selection="
$response = InEvent\Ally::find($client, [
  "tokenID" => "",
  "selection" => ""
]);

Returns all allies, filtered by selection selection and optional parameters.

tokenIDQUERY : token identifier

selectionQUERY : connection status

{
    "all": "all allies",
    "created": "ally created",
    "contacted": "ally contacted"
}

*orderQUERY : results order

ally.sync

( tokenID, eventID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=ally.syncHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=ally.sync&tokenID=&eventID=" \   -d "content="
$response = InEvent\Ally::sync($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Syncs and normalizes contacts from eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : content as JSON

[
    {
        "linkedIn": "string",
        "telephones": [
            "string",
            "..."
        ],
        "emails": [
            "string",
            "..."
        ]
    }
]

Analytics

A series of requests to extract relevant information from the results obtained in several interactive platforms during all event stages.

Models

{
    "count": 1,
    "data": [
        []
    ]
}

Methods

analytics.get

( tokenID, companyID, *personID, page )

  • Info
  • Curl
  • PHP
GET /api/?action=analytics.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=analytics.get&tokenID=&companyID=&page="
$response = InEvent\Analytics::get($client, [
  "tokenID" => "",
  "companyID" => "",
  "page" => ""
]);

Gets statistic data on each page page usage.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

*personIDQUERY : person identifier

pageQUERY : page name

{
    "budget": "budget analytics"
}

( tokenID, eventID, *personID, page )

  • Info
  • Curl
  • PHP
GET /api/?action=analytics.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=analytics.get&tokenID=&eventID=&page="
$response = InEvent\Analytics::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "page" => ""
]);

Gets statistic data on each page page usage.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*personIDQUERY : person identifier

pageQUERY : page name

{
    "event": "event",
    "feed": "news feed",
    "admin": "admins",
    "app": "application",
    "people": "people",
    "peopleConnections": "connections",
    "peopleRanking": "ranking",
    "person": "person data",
    "sponsors": "sponsors",
    "sponsorDataCollector": "data collectors",
    "activities": "activities"
}

App

Third party vendors may have their own connectors with InEvent API.

Models

{
    "count": 1,
    "data": [
        {
            "memberID": "",
            "title": "",
            "description": "",
            "icon": "",
            "returnUrl": "",
            "date": ""
        }
    ]
}

Methods

app.create

( tokenID, title )

  • Info
  • Curl
  • PHP
POST /api/?action=app.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=app.create&tokenID=" \   -d "title="
$response = InEvent\App::create($client, [
  "tokenID" => ""
], [
  "title" => ""
]);

Creates an app with title title for developer.

tokenIDQUERY : token identifier

titleBODY : app title

app.edit

( tokenID, appID, key, *value )

  • Info
  • Curl
  • PHP
POST /api/?action=app.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=app.edit&tokenID=&appID=&key=" \   -d ""
$response = InEvent\App::edit($client, [
  "tokenID" => "",
  "appID" => "",
  "key" => ""
], [

]);

Edits value value from field key at app appID.

tokenIDQUERY : token identifier

appIDQUERY : app identifier

keyQUERY : field name

{
    "title": "app title",
    "description": "app description",
    "icon": "app icon",
    "returnUrl": "app return path"
}

*valueBODY : field value

{
    "title": "string",
    "description": "string",
    "icon": "string",
    "returnUrl": "string"
}

app.remove

( tokenID, appID )

  • Info
  • Curl
  • PHP
GET /api/?action=app.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=app.remove&tokenID=&appID="
$response = InEvent\App::remove($client, [
  "tokenID" => "",
  "appID" => ""
]);

Removes an app appID.

tokenIDQUERY : token identifier

appIDQUERY : app identifier

app.find

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=app.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=app.find&tokenID="
$response = InEvent\App::find($client, [
  "tokenID" => ""
]);

Returns all apps for developer.

tokenIDQUERY : token identifier

app.get

( tokenID, appID )

  • Info
  • Curl
  • PHP
GET /api/?action=app.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=app.get&tokenID=&appID="
$response = InEvent\App::get($client, [
  "tokenID" => "",
  "appID" => ""
]);

Returns an app appID for developer.

tokenIDQUERY : token identifier

appIDQUERY : app identifier

App Person

Third party vendors may have their own connectors with InEvent API.

Models

{
    "count": 1,
    "data": [
        {
            "appID": "",
            "memberID": "",
            "date": ""
        }
    ]
}

Methods

app.person.bind

( tokenID, appID )

  • Info
  • Curl
  • PHP
GET /api/?action=app.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=app.person.bind&tokenID=&appID="
$response = InEvent\App.person::bind($client, [
  "tokenID" => "",
  "appID" => ""
]);

Authenticates person with app appID.

tokenIDQUERY : token identifier

appIDQUERY : app identifier

app.person.dismiss

( tokenID, appID )

  • Info
  • Curl
  • PHP
GET /api/?action=app.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=app.person.dismiss&tokenID=&appID="
$response = InEvent\App.person::dismiss($client, [
  "tokenID" => "",
  "appID" => ""
]);

Removes an app appID for person.

tokenIDQUERY : token identifier

appIDQUERY : app identifier

app.person.find

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=app.person.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=app.person.find&tokenID="
$response = InEvent\App.person::find($client, [
  "tokenID" => ""
]);

Returns all apps authenticated for person.

tokenIDQUERY : token identifier

Audit

Control over information is essential for large companies and their compliance programs. Using the audit log you will be able to review relevant changes at a specific event.

Models

{
    "count": 1,
    "data": [
        {
            "auditID": "1",
            "companyID": "1",
            "eventID": "1",
            "memberID": "1",
            "target": "member",
            "targetID": "1",
            "action": "",
            "referer": "",
            "from": "",
            "to": "event.person.bind",
            "date": "1527689871"
        }
    ]
}

Methods

audit.find

( tokenID, companyID, *query, *queryKey, *queryContent )

  • Info
  • Curl
  • PHP
POST /api/?action=audit.findHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=audit.find&tokenID=&companyID=" \   -d ""
$response = InEvent\Audit::find($client, [
  "tokenID" => "",
  "companyID" => ""
], [

]);

Gathers all audits at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

*queryQUERY : search query

*queryKeyQUERY : search key

{
    "target": "string",
    "targetID": "integer",
    "action": "string",
    "referer": "string",
    "from": "string",
    "to": "string"
}

*queryContentBODY : search key and values as AND operation

[
    {
        "query": "event.person.bind",
        "queryKey": "target"
    },
    {
        "query": "1924",
        "queryKey": "targetID"
    }
]

( tokenID, eventID, *query, *queryKey, *queryContent )

  • Info
  • Curl
  • PHP
POST /api/?action=audit.findHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=audit.find&tokenID=&eventID=" \   -d ""
$response = InEvent\Audit::find($client, [
  "tokenID" => "",
  "eventID" => ""
], [

]);

Gathers all audits at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*queryQUERY : search query

*queryKeyQUERY : search key

{
    "target": "string",
    "targetID": "integer",
    "action": "string",
    "referer": "string",
    "from": "string",
    "to": "string"
}

*queryContentBODY : search key and values as AND operation

[
    {
        "query": "company.person.bind",
        "queryKey": "target"
    },
    {
        "query": "1924",
        "queryKey": "targetID"
    }
]

Beacon

Customers can take advantage of beacons to send targeted push notifications or perform a range of other actions during the event.

Models

{
    "count": 1,
    "data": [
        {
            "beaconID": "1",
            "serial": "1",
            "bleAddress": "b8:27:eb:da:e6:38",
            "iBeaconMinor": "20",
            "wifiAddress": "b8:27:eb:da:e6:38",
            "date": "1415152800"
        }
    ]
}

Methods

beacon.create

( tokenID, serial, iBeaconMinor, bleAddress, wifiAddress )

  • Info
  • Curl
  • PHP
POST /api/?action=beacon.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=beacon.create&tokenID=" \   -d "serial=&iBeaconMinor=&bleAddress=&wifiAddress="
$response = InEvent\Beacon::create($client, [
  "tokenID" => ""
], [
  "serial" => "",
  "iBeaconMinor" => "",
  "bleAddress" => "",
  "wifiAddress" => ""
]);

Creates a beacon with serial serial, BLE MAC Address bleAddress and AP MAC Address wifiAddress.

tokenIDQUERY : token identifier

serialBODY : beacon's serial

iBeaconMinorBODY : beacon's minor

bleAddressBODY : beacon's bleAddress

wifiAddressBODY : beacon's wifiAddress

beacon.find

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=beacon.find&tokenID="
$response = InEvent\Beacon::find($client, [
  "tokenID" => ""
]);

Returns all beacons from InEvent.

tokenIDQUERY : token identifier

Beacon actions

Defines the actions each availble beacon will perform during the event. It's possible to combine several actions in the same beacon, enabling and disabling those actions during the event.

Models

{
    "count": 1,
    "data": [
        {
            "beaconEventID": "1",
            "eventID": "1",
            "beaconID": "2",
            "type": "push",
            "range": "7900",
            "extra": "Hello World"
        }
    ]
}

Methods

beacon.action.bind

( tokenID, beaconEventID, type, range, extra, name )

  • Info
  • Curl
  • PHP
POST /api/?action=beacon.action.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=beacon.action.bind&tokenID=&beaconEventID=" \   -d "type=&range=&extra=&name="
$response = InEvent\Beacon.action::bind($client, [
  "tokenID" => "",
  "beaconEventID" => ""
], [
  "type" => "",
  "range" => "",
  "extra" => "",
  "name" => ""
]);

Adds an action type when beacon is inside of range range.

tokenIDQUERY : authentication token

beaconEventIDQUERY : beacon event identifier

typeBODY : action to be performed

{
    "push": "send push notification"
}

rangeBODY : maximum distance to beacon

extraBODY : extra value used by the action

nameBODY : name used by the action

( tokenID, eventID, minor, type, range, extra, name )

  • Info
  • Curl
  • PHP
POST /api/?action=beacon.action.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=beacon.action.bind&tokenID=&eventID=&minor=" \   -d "type=&range=&extra=&name="
$response = InEvent\Beacon.action::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "minor" => ""
], [
  "type" => "",
  "range" => "",
  "extra" => "",
  "name" => ""
]);

Adds an action type when beacon is inside of range range.

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

minorQUERY : beacon minor for event

typeBODY : action to be performed

{
    "push": "send push notification"
}

rangeBODY : maximum distance to beacon

extraBODY : extra value used by the action

nameBODY : name used by the action

beacon.action.operate

( tokenID, beaconActionID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=beacon.action.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=beacon.action.operate&tokenID=&beaconActionID=&key=" \   -d "value="
$response = InEvent\Beacon.action::operate($client, [
  "tokenID" => "",
  "beaconActionID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of action beaconActionID.

tokenIDQUERY : token identifier

beaconActionIDQUERY : beacon's action identifier

keyQUERY : element name

{
    "active": "action status"
}

valueBODY : desired action

{
    "active": "integer"
}

beacon.action.dismiss

( tokenID, beaconActionID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.action.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=beacon.action.dismiss&tokenID=&beaconActionID="
$response = InEvent\Beacon.action::dismiss($client, [
  "tokenID" => "",
  "beaconActionID" => ""
]);

Removes action beaconActionID.

tokenIDQUERY : authentication token

beaconActionIDQUERY : beacon's action identifier

beacon.action.find

( tokenID, beaconEventID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.action.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=beacon.action.find&tokenID=&beaconEventID="
$response = InEvent\Beacon.action::find($client, [
  "tokenID" => "",
  "beaconEventID" => ""
]);

Finds all actions on beacon at event beaconEventID.

tokenIDQUERY : authentication token

beaconEventIDQUERY : beacon event identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.action.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=beacon.action.find&tokenID=&eventID="
$response = InEvent\Beacon.action::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Finds all actions at event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : beacon's action identifier

Beacon at event

Some event make use of beacons in order to interact with the participants. Those beacons can be added to the customer's package through our team's local mapping, allowing messages customization.

Models

{
    "count": 1,
    "data": [
        {
            "beaconEventID": "1",
            "eventID": "1",
            "beaconID": "2",
            "type": "push",
            "range": "7900",
            "extra": "Hello World"
        }
    ]
}

Methods

beacon.event.bind

( tokenID, eventID, beaconID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.event.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=beacon.event.bind&tokenID=&eventID=&beaconID="
$response = InEvent\Beacon.event::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "beaconID" => ""
]);

Adds a beacon beaconID at event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

beaconIDQUERY : beacon identifier

( tokenID, eventID, minor )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.event.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=beacon.event.bind&tokenID=&eventID=&minor="
$response = InEvent\Beacon.event::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "minor" => ""
]);

Adds a beacon with minor at event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

minorQUERY : beacon minor

beacon.event.dismiss

( tokenID, eventID, beaconID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.event.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=beacon.event.dismiss&tokenID=&eventID=&beaconID="
$response = InEvent\Beacon.event::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "beaconID" => ""
]);

Removes beacon beaconID from event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

beaconIDQUERY : beacon identifier

( tokenID, eventID, minor )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.event.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=beacon.event.dismiss&tokenID=&eventID=&minor="
$response = InEvent\Beacon.event::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "minor" => ""
]);

Removes beacon with minor from event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

minorQUERY : beacon minor

beacon.event.find

( tokenID, eventID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.event.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=beacon.event.find&tokenID=&eventID=&selection="
$response = InEvent\Beacon.event::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Finds beacons at event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

selectionQUERY : options status

{
    "all": "default option",
    "has-action": "only with action"
}

Beacon logs

Stores history of all beacons registered actions along the event.

Models

{
    "count": 1,
    "data": [
        {
            "beaconEventID": "1",
            "eventID": "1",
            "beaconID": "2",
            "type": "push",
            "range": "7900",
            "extra": "Hello World"
        }
    ]
}

Methods

beacon.log.bind

( tokenID, personID, beaconActionID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.log.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=beacon.log.bind&tokenID=&personID=&beaconActionID="
$response = InEvent\Beacon.log::bind($client, [
  "tokenID" => "",
  "personID" => "",
  "beaconActionID" => ""
]);

Registers beacon action beaconActionID performed.

tokenIDQUERY : authentication token

personIDQUERY : person identifier

beaconActionIDQUERY : beacon's action identifier

( tokenID, beaconActionID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.log.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=beacon.log.bind&tokenID=&beaconActionID="
$response = InEvent\Beacon.log::bind($client, [
  "tokenID" => "",
  "beaconActionID" => ""
]);

Registers beacon action beaconActionID performed.

tokenIDQUERY : authentication token

beaconActionIDQUERY : beacon's action identifier

beacon.log.count

( tokenID, beaconEventID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.log.countHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=beacon.log.count&tokenID=&beaconEventID="
$response = InEvent\Beacon.log::count($client, [
  "tokenID" => "",
  "beaconEventID" => ""
]);

Counts all registries from beacon at event beaconEventID.

tokenIDQUERY : authentication token

beaconEventIDQUERY : beacon's identifier at event

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.log.countHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=beacon.log.count&tokenID=&eventID="
$response = InEvent\Beacon.log::count($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Counts all registries at event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

Billing

Billing and information control system for email and SMS products, helping organizers communicate with attendees and guests.

Models

{
    "count": 1,
    "data": [
        {
            "billingID": "1",
            "companyID": "1",
            "eventID": "1",
            "product": "email",
            "amount": "500",
            "sent": "11"
        }
    ]
}

Methods

billing.find

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=billing.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=billing.find&tokenID=&companyID="
$response = InEvent\Billing::find($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns current amounts available at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=billing.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=billing.find&tokenID=&eventID="
$response = InEvent\Billing::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns current amounts available at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

Billing Payment

Payment for product refill on company billing.

Models

{
    "count": 1,
    "data": [
        {
            "billingID": "1",
            "companyID": "1",
            "eventID": "1",
            "product": "email",
            "amount": "500",
            "sent": "11"
        }
    ]
}

Methods

billing.payment.create

( tokenID, companyID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=billing.payment.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=billing.payment.create&tokenID=&companyID=" \   -d "content="
$response = InEvent\Billing.payment::create($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "content" => ""
]);

Create a new billing payment for companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

contentBODY : payment json

Budget

Events got to have a budget controle and we help them in a concise and simple way.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "",
            "description": "",
            "type": "",
            "price": "",
            "date": ""
        }
    ]
}

Methods

budget.create

( tokenID, eventID, title, *description, type, *category, *supplier, *status, price, date, mode )

  • Info
  • Curl
  • PHP
POST /api/?action=budget.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=budget.create&tokenID=&eventID=" \   -d "title=&type=&price=&date=&mode="
$response = InEvent\Budget::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "title" => "",
  "type" => "",
  "price" => "",
  "date" => "",
  "mode" => ""
]);

Creates a registry of expenditures at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

titleBODY : expense title

*descriptionBODY : expense description

typeBODY : type of expense

{
    "raw": "generic expense",
    "totalLodging": "total expense with hotels",
    "totalFlight": "total expense with flights",
    "totalShuttle": "total expense with transfers"
}

*categoryBODY : expense category

*supplierBODY : expense supplier

*statusBODY : expense status

priceBODY : expense price

dateBODY : expense date

modeBODY : expense type

{
    "income": "income",
    "expense": "expense"
}

budget.edit

( tokenID, budgetID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=budget.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=budget.edit&tokenID=&budgetID=&key=" \   -d "value="
$response = InEvent\Budget::edit($client, [
  "tokenID" => "",
  "budgetID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of expense budgetID.

tokenIDQUERY : token identifier

budgetIDQUERY : expense identifier

keyQUERY : field name

{
    "title": "data",
    "description": "data",
    "category": "data",
    "supplier": "data",
    "status": "data",
    "price": "data",
    "date": "data"
}

valueBODY : field value

{
    "title": "data",
    "description": "data",
    "category": "data",
    "supplier": "data",
    "status": "data",
    "price": "data",
    "date": "data"
}

budget.remove

( tokenID, budgetID )

  • Info
  • Curl
  • PHP
GET /api/?action=budget.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=budget.remove&tokenID=&budgetID="
$response = InEvent\Budget::remove($client, [
  "tokenID" => "",
  "budgetID" => ""
]);

Removes expense budgetID from event.

tokenIDQUERY : token identifier

budgetIDQUERY : expense identifier

budget.get

( tokenID, budgetID )

  • Info
  • Curl
  • PHP
GET /api/?action=budget.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=budget.get&tokenID=&budgetID="
$response = InEvent\Budget::get($client, [
  "tokenID" => "",
  "budgetID" => ""
]);

Returns expense budgetID.

tokenIDQUERY : token identifier

budgetIDQUERY : expense identifier

budget.getCategories

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=budget.getCategoriesHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=budget.getCategories&tokenID=&eventID="
$response = InEvent\Budget::getCategories($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all categories for expenses at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

budget.getSuppliers

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=budget.getSuppliersHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=budget.getSuppliers&tokenID=&eventID="
$response = InEvent\Budget::getSuppliers($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all suppliers for expenses at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

budget.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=budget.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=budget.find&tokenID=&eventID="
$response = InEvent\Budget::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all expenses at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

Budget log

This module helps us to log every change made in a spent.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "",
            "personID": "",
            "budgetID": "",
            "key": "",
            "oldValue": "",
            "newValue": "",
            "date": ""
        }
    ]
}

Methods

budget.log.find

( tokenID, eventID, budgetID )

  • Info
  • Curl
  • PHP
GET /api/?action=budget.log.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=budget.log.find&tokenID=&eventID=&budgetID="
$response = InEvent\Budget.log::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "budgetID" => ""
]);

Returns all logs for an expenditure budgetID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

budgetIDQUERY : expense identifier

Case study

After the event, is created a document summarizing its obtained results.

Models

{
    "count": 1,
    "data": [
        {
            "caseID": "1",
            "eventID": "1",
            "attendees": "100",
            "downloads": "400",
            "impressions": "3000",
            "challenges": "Long text.",
            "solution": "Long text.",
            "results": "Long text.",
            "date": "1415152800",
            "active": "1"
        }
    ]
}

Methods

case.edit

( tokenID, eventID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=case.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=case.edit&tokenID=&eventID=&key=" \   -d "value="
$response = InEvent\Case::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key from case study at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : field name

{
    "attendees": "number of participants",
    "downloads": "number of downloads",
    "impressions": "number of prints",
    "headline": "event main summary",
    "challenges": "challenges faced",
    "solution": "solutions used",
    "results": "obtained results",
    "videoKey": "youtube identifier",
    "slideKey": "slideshare identifier"
}

valueBODY : field value

{
    "attendees": "integer",
    "downloads": "integer",
    "impressions": "integer",
    "headline": "string",
    "challenges": "string",
    "solution": "string",
    "results": "string",
    "videoKey": "string",
    "slideKey": "string"
}

case.find

( )

  • Info
  • Curl
  • PHP
GET /api/?action=case.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=case.find"
$response = InEvent\Case::find($client, [

]);

Returns all active case studies.

case.get

( eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=case.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=case.get&eventID="
$response = InEvent\Case::get($client, [
  "eventID" => ""
]);

Returns case study at event eventID.

eventIDQUERY : event identifier

Chain

Creates a chain for event chaining.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "1",
            "name": "Activity X"
        }
    ]
}

Methods

chain.create

( tokenID, eventID, name, *constraint )

  • Info
  • Curl
  • PHP
POST /api/?action=chain.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=chain.create&tokenID=&eventID=" \   -d "name="
$response = InEvent\Chain::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => ""
]);

Creates a chain with name name at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : chain name

*constraintBODY : chain rule

chain.remove

( tokenID, chainID )

  • Info
  • Curl
  • PHP
GET /api/?action=chain.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=chain.remove&tokenID=&chainID="
$response = InEvent\Chain::remove($client, [
  "tokenID" => "",
  "chainID" => ""
]);

Removes chain chainID.

tokenIDQUERY : token identifier

chainIDQUERY : activity identifier

chain.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chain.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=chain.find&tokenID=&eventID="
$response = InEvent\Chain::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all chains at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

Chat

For each event, people can communicate using the instant chat tool. It's an excellent way of creating networking and capturing valuable leads.

Models

{
    "count": 1,
    "data": [
        {
            "chatID": "4",
            "senderID": "1",
            "receiverID": "15",
            "eventID": "6005",
            "message": "Hello, how are you?",
            "date": "1400524839",
            "viewed": "0"
        }
    ]
}

Push Notification

chat/send

_person

Informs the sent of message to person personID.

{
    "personID": "integer"
}

Methods

chat.create

( tokenID, eventID, personID, message )

  • Info
  • Curl
  • PHP
POST /api/?action=chat.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=chat.create&tokenID=&eventID=&personID=" \   -d "message="
$response = InEvent\Chat::create($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
], [
  "message" => ""
]);

Sends message message to person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

messageBODY : message (200)

chat.find

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=chat.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=chat.find&tokenID=&eventID=&personID="
$response = InEvent\Chat::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Returns all messages sent between person tokenID and person personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chat.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=chat.find&tokenID=&eventID="
$response = InEvent\Chat::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns everyone which whom person tokenID interacted at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

chat.get

( tokenID, chatID )

  • Info
  • Curl
  • PHP
GET /api/?action=chat.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=chat.get&tokenID=&chatID="
$response = InEvent\Chat::get($client, [
  "tokenID" => "",
  "chatID" => ""
]);

Returns message chatID.

tokenIDQUERY : token identifier

chatIDQUERY : message identifier

chat.view

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=chat.viewHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=chat.view&tokenID=&eventID=&personID="
$response = InEvent\Chat::view($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Marks conversation between person tokenID with person personID at event eventID as read.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

Chatter

Module destinated to integrations with Salesforce's Chatter, used at an event.

Methods

chatter.get

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=chatter.get&tokenID=&eventID="
$response = InEvent\Chatter::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns authentication tokens linked to event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

chatter.unlink

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.unlinkHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=chatter.unlink&tokenID=&eventID="
$response = InEvent\Chatter::unlink($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Unlinks Chatter integration from event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

chatter.getCommunities

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.getCommunitiesHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=chatter.getCommunities&tokenID=&eventID="
$response = InEvent\Chatter::getCommunities($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns communities in token context vinculated to Chatter at event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

chatter.getGroups

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.getGroupsHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=chatter.getGroups&tokenID=&eventID="
$response = InEvent\Chatter::getGroups($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns groups in token context vinculated to Chatter at event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

chatter.setCommunity

( tokenID, eventID, communityId, communityUrl, communityName )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.setCommunityHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=chatter.setCommunity&tokenID=&eventID=&communityId=&communityUrl=&communityName="
$response = InEvent\Chatter::setCommunity($client, [
  "tokenID" => "",
  "eventID" => "",
  "communityId" => "",
  "communityUrl" => "",
  "communityName" => ""
]);

Links a Chatter community with event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

communityIdQUERY : community identifier

communityUrlQUERY : community url

communityNameQUERY : community name

chatter.unsetCommunity

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.unsetCommunityHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=chatter.unsetCommunity&tokenID=&eventID="
$response = InEvent\Chatter::unsetCommunity($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Unlinks Chatter communities from event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

chatter.setGroup

( tokenID, eventID, groupId, groupName )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.setGroupHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=chatter.setGroup&tokenID=&eventID=&groupId=&groupName="
$response = InEvent\Chatter::setGroup($client, [
  "tokenID" => "",
  "eventID" => "",
  "groupId" => "",
  "groupName" => ""
]);

Links a Chatter group with event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

groupIdQUERY : community identifier

groupNameQUERY : community name

chatter.unsetGroup

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.unsetGroupHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=chatter.unsetGroup&tokenID=&eventID="
$response = InEvent\Chatter::unsetGroup($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Unlinks Chatter groups from event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

Check-In/Out

During the event organizers can perform activities and event check-in/out.

Models

{
    "count": 1,
    "data": [
        []
    ]
}

Methods

checklog.checkIn

( tokenID, eventID, activityID, code, date )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.checkInHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=checklog.checkIn&tokenID=&eventID=&activityID=&code=&date="
$response = InEvent\Checklog::checkIn($client, [
  "tokenID" => "",
  "eventID" => "",
  "activityID" => "",
  "code" => "",
  "date" => ""
]);

Performs check-in of person code at activity activityID from event eventID on time date.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

activityIDQUERY : activity identifier

codeQUERY : identification key

dateQUERY : arrival date

( tokenID, eventID, code, date )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.checkInHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=checklog.checkIn&tokenID=&eventID=&code=&date="
$response = InEvent\Checklog::checkIn($client, [
  "tokenID" => "",
  "eventID" => "",
  "code" => "",
  "date" => ""
]);

Performs check-in from person code at event eventID on time date.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

codeQUERY : identification key

dateQUERY : arrival date

checklog.checkOut

( tokenID, eventID, activityID, code, date )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.checkOutHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=checklog.checkOut&tokenID=&eventID=&activityID=&code=&date="
$response = InEvent\Checklog::checkOut($client, [
  "tokenID" => "",
  "eventID" => "",
  "activityID" => "",
  "code" => "",
  "date" => ""
]);

Performs check-out from person code at activity activityID at event eventID on time date.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

activityIDQUERY : activity identifier

codeQUERY : identification key

dateQUERY : departure date

( tokenID, eventID, code, date )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.checkOutHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=checklog.checkOut&tokenID=&eventID=&code=&date="
$response = InEvent\Checklog::checkOut($client, [
  "tokenID" => "",
  "eventID" => "",
  "code" => "",
  "date" => ""
]);

Performs check-in from person code at event eventID on time date.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

codeQUERY : identification key

dateQUERY : departure date

checklog.stats

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.statsHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=checklog.stats&tokenID=&eventID="
$response = InEvent\Checklog::stats($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gets check-ins/out status and prints at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

checklog.checkedIn

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.checkedInHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=checklog.checkedIn&tokenID=&eventID="
$response = InEvent\Checklog::checkedIn($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gets everyone registered at eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

( tokenID, eventID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.checkedInHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=checklog.checkedIn&tokenID=&eventID=&activityID="
$response = InEvent\Checklog::checkedIn($client, [
  "tokenID" => "",
  "eventID" => "",
  "activityID" => ""
]);

Gets everyone registered at activity activityID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

activityIDQUERY : activity identifier

checklog.find

( tokenID, eventID, *selection, *key, *query, *sort, *sortDirection )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=checklog.find&tokenID=&eventID="
$response = InEvent\Checklog::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Exports an excel spreadsheet for event eventID given a selection selection.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*selectionQUERY : which contents should return

{
    "all": "all logs",
    "printed": "logs for printed badges",
    "timeDiff": "logs for grouped check-in and check-out"
}

*keyQUERY : search query key

{
    "generic": "generic search, find by names",
    "activity": "search by activity identifier",
    "collector": "search by collector identifier",
    "timeInterval": "search by time interval"
}

*queryQUERY : search query

*sortQUERY : search sort

{
    "name": "sort by name",
    "email": "sort by email",
    "activity": "sort by activity",
    "collector": "sort by collector",
    "type": "sort by type",
    "date": "sort by date",
    "dateCheckin": "sort by check-in date",
    "dateCheckout": "sort by check-out date",
    "duration": "sort by duration"
}

*sortDirectionQUERY : search order direction

{
    "ASC": "sort by ascending",
    "DESC": "sort by descending"
}

Comment

Inside an activity, several comments can be added from different participants in order to discuss a specific subject.

Models

{
    "count": 1,
    "data": [
        {
            "commentID": "1",
            "activityID": "14",
            "personID": "1",
            "personName": "John Smith",
            "text": "First post",
            "date": "1413234163"
        }
    ]
}

Methods

comment.create

( tokenID, activityID, text, *compact )

  • Info
  • Curl
  • PHP
POST /api/?action=comment.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=comment.create&tokenID=&activityID=" \   -d "text="
$response = InEvent\Comment::create($client, [
  "tokenID" => "",
  "activityID" => ""
], [
  "text" => ""
]);

Adds comment text at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

textBODY : comment text

*compactQUERY : should return compact comments

comment.edit

( tokenID, commentID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=comment.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=comment.edit&tokenID=&commentID=&key=" \   -d "value="
$response = InEvent\Comment::edit($client, [
  "tokenID" => "",
  "commentID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key from comment commentID.

tokenIDQUERY : token identifier

commentIDQUERY : comment identifier

keyQUERY : field name

{
    "approved": "approved"
}

valueBODY : field value

{
    "approved": "bit"
}

comment.remove

( tokenID, commentID )

  • Info
  • Curl
  • PHP
GET /api/?action=comment.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=comment.remove&tokenID=&commentID="
$response = InEvent\Comment::remove($client, [
  "tokenID" => "",
  "commentID" => ""
]);

Removes comment commentID.

tokenIDQUERY : token identifier

commentIDQUERY : comment identifier

comment.find

( tokenID, activityID, selection, *orderDirection, *compact )

  • Info
  • Curl
  • PHP
GET /api/?action=comment.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=comment.find&tokenID=&activityID=&selection="
$response = InEvent\Comment::find($client, [
  "tokenID" => "",
  "activityID" => "",
  "selection" => ""
]);

Returns all comments from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

selectionQUERY : comments on activity

{
    "all": "all comments",
    "approved+me": "comments approved and participant's own comments"
}

*orderDirectionQUERY : order direction based on column

*compactQUERY : should return compact comments

comment.get

( tokenID, commentID )

  • Info
  • Curl
  • PHP
GET /api/?action=comment.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=comment.get&tokenID=&commentID="
$response = InEvent\Comment::get($client, [
  "tokenID" => "",
  "commentID" => ""
]);

Returns comment commentID.

tokenIDQUERY : token identifier

commentIDQUERY : comment identifier

comment.hashtags

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=comment.hashtagsHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=comment.hashtags&tokenID=&activityID="
$response = InEvent\Comment::hashtags($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns hashtag statistics for an activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

Company

For continuous use of API with exclusive benefits to partners is necessary to create the company inside InEvent's platform, providing a better control over security and uses limitations. For each registered company, a company identifier is generated with its details, members, events and partners.

Models

{
    "count": 1,
    "data": [
        {
            "companyID": "1",
            "shortName": "InEvent",
            "storeTitle": "InEvent - Empowering people on events",
            "appIcon": "uploads\/1396576595.png",
            "storeIcon": "uploads\/1396576595.png",
            "cover": "uploads\/1396576595.png",
            "splash": "uploads\/1396576595.png",
            "androidBundle": "us.inevent.apps.demo",
            "iosBundle": "us.inevent.apps.demo",
            "androidApp": "https:\/\/play.google.com\/store\/apps\/details?id=us.inevent.apps.demo",
            "iosApp": "https:\/\/itunes.apple.com\/ca\/app\/inevent-tour\/id995325465?mt=8",
            "agreement": "https:\/\/path\/to\/agreement",
            "keywords": "app,events,success",
            "backgroundColor": "#A3A3A3",
            "navigationBarBackgroundColor": "#A3A3A3",
            "androidVersion": "1.0",
            "iosVersion": "1.0",
            "language": "1",
            "currency": "USD"
        }
    ]
}

Methods

company.create

( tokenID, code, plan, companyName, appIcon, *notes )

  • Info
  • Curl
  • PHP
POST /api/?action=company.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.create&tokenID=" \   -d "code=&plan=&companyName=&appIcon="
$response = InEvent\Company::create($client, [
  "tokenID" => ""
], [
  "code" => "",
  "plan" => "",
  "companyName" => "",
  "appIcon" => ""
]);

Requests creation of a company for trial.

tokenIDQUERY : token identifier

codeBODY : verification code

planBODY : trial plan

companyNameBODY : company name

appIconBODY : company logo

*notesBODY : additional information

( tokenID, plan, companyName, appIcon, region )

  • Info
  • Curl
  • PHP
POST /api/?action=company.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.create&tokenID=" \   -d "plan=&companyName=&appIcon=®ion="
$response = InEvent\Company::create($client, [
  "tokenID" => ""
], [
  "plan" => "",
  "companyName" => "",
  "appIcon" => "",
  "region" => ""
]);

Creates a company companyName.

tokenIDQUERY : token identifier

planBODY : company plan

companyNameBODY : company name

appIconBODY : company icon

regionBODY : legal region

( tokenID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=company.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.create&tokenID=" \   -d "path="
$response = InEvent\Company::create($client, [
  "tokenID" => ""
], [
  "path" => ""
]);

Creates multiple companies.

tokenIDQUERY : token identifier

pathBODY : file path

company.edit

( tokenID, companyID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=company.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.edit&tokenID=&companyID=&key=" \   -d "value="
$response = InEvent\Company::edit($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

keyQUERY : field name

{
    "shortName": "app title",
    "storeTitle": "stores title",
    "location": "electronic address",
    "appIcon": "main icon",
    "storeIcon": "store icon",
    "cover": "cover image on opening",
    "androidBundle": "android identifier",
    "iosBundle": "iOS identifier",
    "agreement": "terms of use",
    "keywords": "keywords for stores",
    "backgroundColor": "background color",
    "navigationBarBackgroundColor": "bar color",
    "mainColor": "main color",
    "splash": "splash image",
    "language": "language",
    "androidReview": "android review",
    "iosReview": "iOS review",
    "customCss": "custom Css for directory page",
    "initialDemo": "show initial demo?"
}

valueBODY : field value

{
    "shortName": "string",
    "storeTitle": "string",
    "location": "string",
    "appIcon": "string",
    "storeIcon": "string",
    "cover": "string",
    "androidBundle": "string",
    "iosBundle": "string",
    "agreement": "string",
    "keywords": "string",
    "backgroundColor": "string",
    "navigationBarBackgroundColor": "string",
    "mainColor": "string",
    "splash": "string",
    "language": "string",
    "androidReview": "bit",
    "iosReview": "bit",
    "customCss": "string",
    "initialDemo": "bit"
}

( onboardingToken, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=company.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.edit&onboardingToken=&key=" \   -d "value="
$response = InEvent\Company::edit($client, [
  "onboardingToken" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key from company with token onboardingToken.

onboardingTokenQUERY : company identifier

keyQUERY : field name

{
    "shortName": "app title",
    "storeTitle": "stores title",
    "appIcon": "main icon",
    "storeIcon": "store icon",
    "keywords": "keywords for stores",
    "backgroundColor": "background color",
    "navigationBarBackgroundColor": "bar color",
    "mainColor": "main color",
    "splash": "splash image"
}

valueBODY : field value

{
    "shortName": "string",
    "storeTitle": "string",
    "appIcon": "string",
    "storeIcon": "string",
    "keywords": "string",
    "backgroundColor": "string",
    "navigationBarBackgroundColor": "string",
    "mainColor": "string",
    "splash": "string"
}

company.find

( tokenID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=company.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.find&tokenID=&selection="
$response = InEvent\Company::find($client, [
  "tokenID" => "",
  "selection" => ""
]);

Returns all companies with tokenID access.

tokenIDQUERY : token identifier

selectionQUERY : selection

{
    "all": "all companies",
    "live": "on production",
    "androidQueue": "to review",
    "iosQueue": "to review",
    "lacksIcon": "waiting for icon",
    "lacksBundle": "waiting for bundle",
    "missingLinks": "waiting for stores link",
    "notWhiteLabel": "isn't white label"
}

company.get

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.get&tokenID=&companyID="
$response = InEvent\Company::get($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns details from company companyID with tokenID access.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

( companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.get&companyID="
$response = InEvent\Company::get($client, [
  "companyID" => ""
]);

Returns details from company companyID.

companyIDQUERY : company identifier

( tokenID, namespace )

  • Info
  • Curl
  • PHP
GET /api/?action=company.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.get&tokenID=&namespace="
$response = InEvent\Company::get($client, [
  "tokenID" => "",
  "namespace" => ""
]);

Returns details from company with namespace namespace with tokenID access.

tokenIDQUERY : token identifier

namespaceQUERY : company namespace

( namespace )

  • Info
  • Curl
  • PHP
GET /api/?action=company.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.get&namespace="
$response = InEvent\Company::get($client, [
  "namespace" => ""
]);

Returns details from company with namespace namespace.

namespaceQUERY : company namespace

( tokenID, nickname )

  • Info
  • Curl
  • PHP
GET /api/?action=company.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.get&tokenID=&nickname="
$response = InEvent\Company::get($client, [
  "tokenID" => "",
  "nickname" => ""
]);

Returns details from company with nickname nickname with tokenID access.

tokenIDQUERY : token identifier

nicknameQUERY : company nickname

( nickname )

  • Info
  • Curl
  • PHP
GET /api/?action=company.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.get&nickname="
$response = InEvent\Company::get($client, [
  "nickname" => ""
]);

Returns details from company with nickname nickname.

nicknameQUERY : company nickname

( onboardingToken )

  • Info
  • Curl
  • PHP
GET /api/?action=company.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.get&onboardingToken="
$response = InEvent\Company::get($client, [
  "onboardingToken" => ""
]);

Returns details from company with onboarding token onboardingToken.

onboardingTokenQUERY : onboarding token

Company admins

For registered companies, admins are people that make management decisions inside each company. Those can have multiple levels, separating them between staff and coordinators.

Models

{
    "count": 1,
    "data": [
        {
            "personID": "1",
            "name": "Pedro Góes",
            "email": "email@email.com",
            "level": "4"
        }
    ]
}
{
    "level": {
        "1": "LEVEL_USER",
        "4": "LEVEL_ADMIN"
    }
}

Methods

company.person.bind

( tokenID, companyID, name, email )

  • Info
  • Curl
  • PHP
POST /api/?action=company.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.person.bind&tokenID=&companyID=" \   -d "name=&email="
$response = InEvent\Company.person::bind($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "name" => "",
  "email" => ""
]);

Adds a person with name name and email email at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

nameBODY : person name

emailBODY : person email

company.person.operate

( tokenID, companyID, key, value, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=company.person.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.person.operate&tokenID=&companyID=&key=&personID=" \   -d "value="
$response = InEvent\Company.person::operate($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

Edits value value from field key to person personID at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

keyQUERY : element name

{
    "level": "admin privilege"
}

valueBODY : field value

{
    "level": "bit"
}

personIDQUERY : person identifier

company.person.dismiss

( tokenID, companyID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.person.dismiss&tokenID=&companyID=&personID="
$response = InEvent\Company.person::dismiss($client, [
  "tokenID" => "",
  "companyID" => "",
  "personID" => ""
]);

Removes person personID from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

personIDQUERY : person identifier

company.person.find

( tokenID, companyID, selection, *order )

  • Info
  • Curl
  • PHP
GET /api/?action=company.person.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.person.find&tokenID=&companyID=&selection="
$response = InEvent\Company.person::find($client, [
  "tokenID" => "",
  "companyID" => "",
  "selection" => ""
]);

Returns everyone at company companyID, filtered by a selection selection and order order.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

selectionQUERY : people at company

{
    "all": "everyone"
}

*orderQUERY : results order

company.person.sync

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.person.syncHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.person.sync&tokenID="
$response = InEvent\Company.person::sync($client, [
  "tokenID" => ""
]);

Syncs everyone with external management platforms.

tokenIDQUERY : token identifier

company.person.journey

( tokenID, companyID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.person.journeyHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.person.journey&tokenID=&companyID=&personID="
$response = InEvent\Company.person::journey($client, [
  "tokenID" => "",
  "companyID" => "",
  "personID" => ""
]);

Gathers person journey throughout company's events.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

personIDQUERY : person identifier

Company notifications

For each company, certificates are needed to validate access at Apple (APNS) and Google (GCM) servers, and to send notifications to the mobile applications. Each one receives a identifier with the information pair for both mobile OSs.

Methods

company.push.bind

( tokenID, companyID, androidKey, iosPath )

  • Info
  • Curl
  • PHP
POST /api/?action=company.push.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.push.bind&tokenID=&companyID=" \   -d "androidKey=&iosPath="
$response = InEvent\Company.push::bind($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "androidKey" => "",
  "iosPath" => ""
]);

Adds a new certificate at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

androidKeyBODY : GCM key

iosPathBODY : APNS path

company.push.dismiss

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.push.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.push.dismiss&tokenID=&companyID="
$response = InEvent\Company.push::dismiss($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Removes certificate from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

company.push.find

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.push.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.push.find&tokenID=&companyID="
$response = InEvent\Company.push::find($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns all certificates at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

Company events

For a company to perform multiple events, becomes important to handle each one of those broadly. After being added, each event can be reviewed and edited before receiving the final approval.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "5922",
            "name": "party",
            "nickname": "#party",
            "email": "email@email.com",
            "description": "Event description",
            "cover": "https:\/\/",
            "dateBegin": "1396576639",
            "dateEnd": "1399168639",
            "enrollmentBegin": "1396576639",
            "enrollmentEnd": "1399168639",
            "latitude": "0",
            "longitude": "0",
            "spot": "",
            "address": "Address",
            "city": "City",
            "state": "State",
            "fugleman": "Organizer",
            "ticketURL": "",
            "facebook": "",
            "twitter": "",
            "visible": "1",
            "public": "1",
            "sandbox": "0",
            "personID": "-1",
            "level": "4",
            "approved": "1",
            "themes": []
        }
    ]
}
{
    "approved": {
        "-1": "not registered",
        "0": "registered and not approved",
        "1": "registered and approved"
    }
}
{
    "level": {
        "1": "LEVEL_USER",
        "4": "LEVEL_ADMIN"
    }
}

Methods

company.event.bind

( tokenID, companyID, name, nickname )

  • Info
  • Curl
  • PHP
POST /api/?action=company.event.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.event.bind&tokenID=&companyID=" \   -d "name=&nickname="
$response = InEvent\Company.event::bind($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "name" => "",
  "nickname" => ""
]);

Creates an event with name name and nickname nickname at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

nameBODY : company name

nicknameBODY : event nickname hashtag

( tokenID, companyID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=company.event.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.event.bind&tokenID=&companyID=" \   -d "path="
$response = InEvent\Company.event::bind($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "path" => ""
]);

Creates multiple events at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

pathBODY : file path

company.event.dismiss

( tokenID, companyID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.event.dismiss&tokenID=&companyID=&eventID="
$response = InEvent\Company.event::dismiss($client, [
  "tokenID" => "",
  "companyID" => "",
  "eventID" => ""
]);

Removes event eventID from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

eventIDQUERY : event identifier

company.event.find

( tokenID, companyID, selection, *name, *city, *dateBegin, *dateEnd, *presential, *public, *visible, *archived, *templateID, *placeID, *order, *timezone )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.event.find&tokenID=&companyID=&selection="
$response = InEvent\Company.event::find($client, [
  "tokenID" => "",
  "companyID" => "",
  "selection" => ""
]);

Returns all events at company companyID, filtered by selection selection and informing if person tokenID is registered.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

selectionQUERY : event registration

{
    "all": "all events",
    "best-fit": "events open for registration and with priorities (1) events on the next 3 days range (2) future events (3) events attending and (4) other events",
    "approved": "registration approved",
    "enrolled": "events enrolled",
    "denied": "registration rejected",
    "paid": "registration paid",
    "present": "person attending",
    "working": "working as staff or coordinator"
}

*nameQUERY : event name

*cityQUERY : city name

*dateBeginQUERY : event's begin date

*dateEndQUERY : event's end date

*presentialQUERY : face-to-face event

*publicQUERY : public event

*visibleQUERY : visible event

*archivedQUERY : show archived events

*templateIDQUERY : template event

*placeIDQUERY : place for event

*orderQUERY : results order

*timezoneQUERY : timezone to search the dates of the event

( tokenID, companyID, selection, *name, *dateBegin, *dateEnd )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.event.find&tokenID=&companyID=&selection="
$response = InEvent\Company.event::find($client, [
  "tokenID" => "",
  "companyID" => "",
  "selection" => ""
]);

Returns all events at company companyID, filtered by selection selection and informing if person tokenID is registered.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

selectionQUERY : event registration

*nameQUERY : event name

*dateBeginQUERY : event's begin date

*dateEndQUERY : event's end date

( companyID, *name, *city, *dateBegin, *dateEnd, *presential, *public, *visible, *order )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.event.find&companyID="
$response = InEvent\Company.event::find($client, [
  "companyID" => ""
]);

Returns all events at company companyID.

companyIDQUERY : company identifier

*nameQUERY : event name

*cityQUERY : city name

*dateBeginQUERY : event's begin date

*dateEndQUERY : event's end date

*presentialQUERY : face-to-face event

*publicQUERY : public event

*visibleQUERY : visible event

*orderQUERY : results order

( companyID, *name, *dateBegin, *dateEnd )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.event.find&companyID="
$response = InEvent\Company.event::find($client, [
  "companyID" => ""
]);

Returns all events at company companyID.

companyIDQUERY : company identifier

*nameQUERY : event name

*dateBeginQUERY : event's begin date

*dateEndQUERY : event's end date

company.event.get

( tokenID, companyID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.event.get&tokenID=&companyID=&eventID="
$response = InEvent\Company.event::get($client, [
  "tokenID" => "",
  "companyID" => "",
  "eventID" => ""
]);

Returns event eventID at company companyID, informing if person tokenID is registered.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

eventIDQUERY : event identifier

( companyID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.event.get&companyID=&eventID="
$response = InEvent\Company.event::get($client, [
  "companyID" => "",
  "eventID" => ""
]);

Returns event eventID at company companyID.

companyIDQUERY : company identifier

eventIDQUERY : event identifier

company.event.findAttendees

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.findAttendeesHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.event.findAttendees&tokenID=&companyID="
$response = InEvent\Company.event::findAttendees($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns all participants of all events from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

company.event.copy

( tokenID, companyID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.copyHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.event.copy&tokenID=&companyID=&eventID="
$response = InEvent\Company.event::copy($client, [
  "tokenID" => "",
  "companyID" => "",
  "eventID" => ""
]);

Copies event eventID at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

eventIDQUERY : event identifier

company.event.budget

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.budgetHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.event.budget&tokenID=&companyID="
$response = InEvent\Company.event::budget($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns budget details from each event at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

company.event.assignOwner

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.assignOwnerHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.event.assignOwner&tokenID=&eventID=&personID="
$response = InEvent\Company.event::assignOwner($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Asigns a company member as administrator and owner of eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

company.event.pin

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.pinHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.event.pin&tokenID=&eventID="
$response = InEvent\Company.event::pin($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Pins event eventID for admin panel.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

company.event.unpin

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.unpinHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.event.unpin&tokenID=&eventID="
$response = InEvent\Company.event::unpin($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Unpins event eventID for admin panel.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

Company features

Indicates which features are enabled at the platform for a specific event

Models

{
    "count": 1,
    "data": [
        {
            "reports": "1",
            "images": "1",
            "tweets": "1",
            "meetings": "1",
            "whiteLabel": "0"
        }
    ]
}

Methods

company.feature.get

( tokenID, companyID, key )

  • Info
  • Curl
  • PHP
GET /api/?action=company.feature.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.feature.get&tokenID=&companyID=&key="
$response = InEvent\Company.feature::get($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
]);

Returns if a particular feature is enabled.

tokenIDQUERY : token identifier

companyIDQUERY : event identifier

keyQUERY : feature key

"Optional; one of the keys from above model. If empty, returns the value for all of them"

company.feature.edit

( tokenID, companyID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=company.feature.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.feature.edit&tokenID=&companyID=&key=" \   -d "value="
$response = InEvent\Company.feature::edit($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
], [
  "value" => ""
]);

Updates status of a particular feature.

tokenIDQUERY : token identifier

companyIDQUERY : event identifier

keyQUERY : feature key

"one of the keys from above model"

valueBODY : field value

company.feature.available

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.feature.availableHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.feature.available&tokenID="
$response = InEvent\Company.feature::available($client, [
  "tokenID" => ""
]);

Returns all products available at InEvent.

tokenIDQUERY : token identifier

Company items

Certain applications need additional items in its menu.

Models

{
    "count": 1,
    "data": [
        {
            "id": "1",
            "companyID": "1",
            "title": "Recruiting",
            "link": "http:\/\/"
        }
    ]
}

Methods

company.link.create

( tokenID, companyID, title, link )

  • Info
  • Curl
  • PHP
POST /api/?action=company.link.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.link.create&tokenID=&companyID=" \   -d "title=&link="
$response = InEvent\Company.link::create($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "title" => "",
  "link" => ""
]);

Adds item with title title and destination link at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

titleBODY : item title

linkBODY : item url

company.link.remove

( tokenID, companyLinkID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.link.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.link.remove&tokenID=&companyLinkID="
$response = InEvent\Company.link::remove($client, [
  "tokenID" => "",
  "companyLinkID" => ""
]);

Removes item companyLinkID.

tokenIDQUERY : token identifier

companyLinkIDQUERY : item identifier

company.link.find

( companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.link.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.link.find&companyID="
$response = InEvent\Company.link::find($client, [
  "companyID" => ""
]);

Gets all items available at company companyID.

companyIDQUERY : company identifier

Legal data

We request our clients to give us access to their legal data for apps publishing reason

Models

{
    "count": 1,
    "data": [
        {
            "name": "Pedro Góes",
            "email": "email@email.com",
            "telephone": "000-000-0000"
        }
    ]
}

Methods

company.legal.edit

( tokenID, companyID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=company.legal.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.legal.edit&tokenID=&companyID=&key=" \   -d "value="
$response = InEvent\Company.legal::edit($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
], [
  "value" => ""
]);

Updates legal data from company companyID on key key with value value.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

keyQUERY : legal data key

"one of the keys from above model"

valueBODY : field value

company.legal.get

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.legal.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.legal.get&tokenID=&companyID="
$response = InEvent\Company.legal::get($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns legal data from company companyID for admin tokenID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

Emails notification

Notifications are triggers sent to the company organizers when determined actions occur on the platform.

Models

{
    "count": 1,
    "data": [
        {
            "id": "1",
            "companyID": "6173",
            "memberID": "1"
        }
    ]
}

Methods

company.notification.operate

( tokenID, companyID, key, *value )

  • Info
  • Curl
  • PHP
POST /api/?action=company.notification.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.notification.operate&tokenID=&companyID=&key=" \   -d ""
$response = InEvent\Company.notification::operate($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
], [

]);

Edits value value from field key for person personID at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

keyQUERY : field name

*valueBODY : field value

company.notification.get

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.notification.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.notification.get&tokenID=&companyID="
$response = InEvent\Company.notification::get($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns notifications of person personID at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

Company tools

Each company contains exclusive tools which can be controlled by its administrators.

Models

{
    "count": 1,
    "data": [
        {
            "id": "1",
            "companyID": "1",
            "feedback": "1",
            "presence": "0",
            "material": "0",
            "question": "1",
            "comment": "1",
            "quiz": "1",
            "speaker": "1",
            "networking": "1",
            "pushNotification": "1",
            "shareOnlyEventDay": "0",
            "searchBar": "1",
            "facebookLogin": "1",
            "linkedInLogin": "1",
            "confirmationEmail": "1",
            "offlinePush": "1",
            "meeting": "1",
            "localTimezone": "0",
            "aboutUs": "1",
            "autoApproveQuestion": "1",
            "autoApproveComment": "1",
            "autoApproveSocialFlow": "1",
            "photo": "1",
            "quickMenu": "1",
            "multipleEvents": "1",
            "sponsors": "1",
            "stream": "1",
            "feed": "0",
            "schedule": "1",
            "linkedInLegacy": "1",
            "hideFullRooms": "0"
        }
    ]
}

Methods

company.tool.edit

( tokenID, companyID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=company.tool.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=company.tool.edit&tokenID=&companyID=&key=" \   -d "value="
$response = InEvent\Company.tool::edit($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key from tools at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

keyQUERY : field name

{
    "feedback": "activities and event feedback",
    "presence": "mark attendance on activities",
    "material": "download materials used on activities",
    "question": "send questions at activities",
    "comment": "send comments on activities",
    "quiz": "answer quizzes on activities",
    "meeting": "meetings scheduling",
    "aboutUs": "about InEvent screen",
    "speaker": "speakers list",
    "networking": "participants list",
    "shareOnlyEventDay": "shares event day only",
    "searchBar": "events search bar",
    "facebookLogin": "login via facebook",
    "linkedInLogin": "login via LinkedIn",
    "confirmationEmail": "confirmation email",
    "photo": "event pictures",
    "quickMenu": "quick actions",
    "multipleEvents": "multiple events"
}

valueBODY : field value

{
    "feedback": "integer(1)",
    "presence": "integer(1)",
    "material": "integer(1)",
    "question": "integer(1)",
    "comment": "integer(1)",
    "quiz": "integer(1)",
    "meeting": "integer(1)",
    "aboutUs": "integer(1)",
    "speaker": "integer(1)",
    "networking": "integer(1)",
    "shareOnlyEventDay": "integer(1)",
    "searchBar": "integer(1)",
    "facebookLogin": "integer(1)",
    "linkedInLogin": "integer(1)",
    "confirmationEmail": "integer(1)",
    "photo": "integer(1)",
    "quickMenu": "integer(1)",
    "multipleEvents": "integer(1)"
}

company.tool.get

( companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.tool.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.tool.get&companyID="
$response = InEvent\Company.tool::get($client, [
  "companyID" => ""
]);

Returns all tools available at company companyID.

companyIDQUERY : company identifier

company.tool.available

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.tool.availableHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=company.tool.available&tokenID="
$response = InEvent\Company.tool::available($client, [
  "tokenID" => ""
]);

Returns all tools available for use.

tokenIDQUERY : token identifier

Discount coupons

It's possible to create discount codes for features

Models

{
    "count": 1,
    "data": [
        {
            "couponID": "1",
            "eventID": "1",
            "code": "78DJX8",
            "discount": "10",
            "used": "1"
        }
    ]
}

Methods

coupon.create

( tokenID, eventID, discount, *code )

  • Info
  • Curl
  • PHP
POST /api/?action=coupon.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=coupon.create&tokenID=&eventID=" \   -d "discount="
$response = InEvent\Coupon::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "discount" => ""
]);

Creates a discount coupon discount at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

discountBODY : discount rate (0-100)

*codeBODY : coupon code

coupon.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=coupon.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=coupon.find&tokenID=&eventID="
$response = InEvent\Coupon::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns coupons for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

coupon.get

( tokenID, eventID, code )

  • Info
  • Curl
  • PHP
POST /api/?action=coupon.getHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=coupon.get&tokenID=&eventID=" \   -d "code="
$response = InEvent\Coupon::get($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "code" => ""
]);

Returns coupon code.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

codeBODY : unique code

Coupon ticket

If a coupon has tickets defined, it will only add discount to specific tickets

Models

{
    "count": 1,
    "data": [
        {
            "id": "1",
            "eventID": "1",
            "couponID": "1",
            "ticketID": "0"
        }
    ]
}

Methods

coupon.ticket.bind

( tokenID, eventID, ticketID, couponID )

  • Info
  • Curl
  • PHP
GET /api/?action=coupon.ticket.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=coupon.ticket.bind&tokenID=&eventID=&ticketID=&couponID="
$response = InEvent\Coupon.ticket::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "ticketID" => "",
  "couponID" => ""
]);

Binds a ticket ticketID to a coupon couponID on event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

ticketIDQUERY : ticket identifier

couponIDQUERY : coupon identifier

coupon.ticket.dismiss

( tokenID, eventID, ticketID, couponID )

  • Info
  • Curl
  • PHP
GET /api/?action=coupon.ticket.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=coupon.ticket.dismiss&tokenID=&eventID=&ticketID=&couponID="
$response = InEvent\Coupon.ticket::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "ticketID" => "",
  "couponID" => ""
]);

Removes ticket ticketID limitation on coupon couponID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

ticketIDQUERY : ticket identifier

couponIDQUERY : coupon identifier

coupon.ticket.find

( tokenID, eventID, couponID )

  • Info
  • Curl
  • PHP
GET /api/?action=coupon.ticket.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=coupon.ticket.find&tokenID=&eventID=&couponID="
$response = InEvent\Coupon.ticket::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "couponID" => ""
]);

Find all ticket limitations for coupon couponID on event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

couponIDQUERY : coupon identifier

Daemon

This API allows users to adquire notifications sent to our daemons for post-processing

Models

{
    "count": 1,
    "data": [
        {
            "*": "mixed"
        }
    ]
}

Methods

daemon.find

( tokenID, eventID, operation, target )

  • Info
  • Curl
  • PHP
GET /api/?action=daemon.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=daemon.find&tokenID=&eventID=&operation=&target="
$response = InEvent\Daemon::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "operation" => "",
  "target" => ""
]);

Returns pending operations for event eventID, operation operation and target target.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

operationQUERY : operation

targetQUERY : target

daemon.bulk

( tokenID, *companyID, eventID, target, *targetID, *resourceID, resourceType, resources, extra )

  • Info
  • Curl
  • PHP
POST /api/?action=daemon.bulkHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=daemon.bulk&tokenID=&eventID=&target=&resourceType=" \   -d "resources=&extra="
$response = InEvent\Daemon::bulk($client, [
  "tokenID" => "",
  "eventID" => "",
  "target" => "",
  "resourceType" => ""
], [
  "resources" => "",
  "extra" => ""
]);

Run bulk operation for several resources.

tokenIDQUERY : token identifier

*companyIDQUERY : company identifier

eventIDQUERY : event identifier

targetQUERY : operation target

*targetIDQUERY : operation target id

*resourceIDQUERY : operation resource id

resourceTypeQUERY : operation resource type

resourcesBODY : operation resources

extraBODY : extra information

Directory

Companies can create an event directory with all their events to be available for the public

Models

{
    "count": 1,
    "data": [
        {
            "directoryID": "1",
            "companyID": "14",
            "template": "lima",
            "cover": "https:\/\/inevent.com\/image.png",
            "title": "Company Title"
        }
    ]
}

Methods

directory.edit

( tokenID, companyID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=directory.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=directory.edit&tokenID=&companyID=&key=" \   -d "value="
$response = InEvent\Directory::edit($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits directory value value from field key at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

keyQUERY : field name

{
    "template": "template to use",
    "cover": "cover image",
    "title": "directory title"
}

valueBODY : field value

{
    "template": "string",
    "cover": "string",
    "title": "string"
}

directory.get

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=directory.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=directory.get&tokenID=&companyID="
$response = InEvent\Directory::get($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns directory for company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

Download

Downloads are ways of extracting data from the platform based on your compliance rules.

Models

{
    "count": 1,
    "data": [
        {
            "downloadID": "1",
            "companyID": "1",
            "eventID": "1",
            "memberID": "1",
            "title": "Spreadsheet",
            "event": "test",
            "type": "xlsx",
            "url": "https:\/\/",
            "date": "1503027673"
        }
    ]
}

Methods

download.remove

( tokenID, downloadID )

  • Info
  • Curl
  • PHP
GET /api/?action=download.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=download.remove&tokenID=&downloadID="
$response = InEvent\Download::remove($client, [
  "tokenID" => "",
  "downloadID" => ""
]);

Remove download downloadID from the system.

tokenIDQUERY : token identifier

downloadIDQUERY : download identifier

download.find

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=download.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=download.find&tokenID=&companyID="
$response = InEvent\Download::find($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns all downloads at companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

Email logs

Stores every email ever sent for further reading, checking and compliance. Includes environmental informations, such as openings timestamps and email statuses.

Models

{
    "count": 1,
    "data": [
        {
            "emailLogID": "1",
            "eventID": "1",
            "memberID": "1",
            "listEmailID": "",
            "messageID": "61270c02-def6-4029-9e8b-9be3dc469d0e",
            "from": "Standalone Out",
            "to": "robert@inevent.com",
            "subject": "Welcome to Standalone Out",
            "status": "delivered",
            "opens": "0",
            "date": "1525269353",
            "personName": "Robert",
            "listID": "",
            "listName": "",
            "listSubject": "",
            "listSelection": "",
            "listSent": "",
            "body": ""
        }
    ]
}

Methods

email.log.find

( tokenID, eventID, selection, query, subject )

  • Info
  • Curl
  • PHP
GET /api/?action=email.log.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=email.log.find&tokenID=&eventID=&selection=&query=&subject="
$response = InEvent\Email.log::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => "",
  "query" => "",
  "subject" => ""
]);

Returns email logs at event eventID, optionally filtered by query and subject.

tokenIDQUERY : token identifier

eventIDQUERY : event

selectionQUERY : segments

queryQUERY : search terms

subjectQUERY : search subject

email.log.get

( tokenID, emailLogID )

  • Info
  • Curl
  • PHP
GET /api/?action=email.log.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=email.log.get&tokenID=&emailLogID="
$response = InEvent\Email.log::get($client, [
  "tokenID" => "",
  "emailLogID" => ""
]);

Returns a specific email log emailLogID.

tokenIDQUERY : token identifier

emailLogIDQUERY : event log identifier

email.log.setConversion

( tokenID, encEmailLogID )

  • Info
  • Curl
  • PHP
POST /api/?action=email.log.setConversionHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=email.log.setConversion&tokenID=" \   -d "encEmailLogID="
$response = InEvent\Email.log::setConversion($client, [
  "tokenID" => ""
], [
  "encEmailLogID" => ""
]);

Set conversion for encrypted email log id.

tokenIDQUERY : token identifier

encEmailLogIDBODY : email log identifier encrypted

Error

Disregarging of the developed product, error unfortunately happen and should be given the proper attention. For each error informed, a message, place and occurence moment are obtained.

Models

{
    "count": 1,
    "data": [
        {
            "personID": "0",
            "platform": "ios",
            "message": "aa",
            "date": "2014-05-12 15:04:41",
            "solved": "0"
        }
    ]
}

Methods

error.create

( tokenID, platform, message, *STACK_TRACE, *STACK_TRACE, *INITIAL_CONFIGURATION, *BUILD )

  • Info
  • Curl
  • PHP
POST /api/?action=error.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=error.create&tokenID=" \   -d "platform=&message="
$response = InEvent\Error::create($client, [
  "tokenID" => ""
], [
  "platform" => "",
  "message" => ""
]);

Informs occurence of error message while person tokenID used the platform platform.

tokenIDQUERY : token identifier

platformBODY : error location

messageBODY : error message

*STACK_TRACEBODY : stacktrace generated by ACRA

*STACK_TRACEBODY : stacktrace generated by ACRA

*INITIAL_CONFIGURATIONBODY : cellphone configuration generated by ACRA

*BUILDBODY : OS version generated by ACRA

error.create

( tokenID, json )

  • Info
  • Curl
  • PHP
POST /api/?action=error.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=error.create&tokenID=" \   -d "json="
$response = InEvent\Error::create($client, [
  "tokenID" => ""
], [
  "json" => ""
]);

Informs occurence of error message while person tokenID used the platform platform.

tokenIDQUERY : token identifier

jsonBODY : json contents from php://input

error.find

( tokenID, *companyID, *eventID, *personID, *platform, *dateBegin, *dateEnd, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=error.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=error.find&tokenID="
$response = InEvent\Error::find($client, [
  "tokenID" => ""
]);

Lookup errors with query and platform.

tokenIDQUERY : token identifier

*companyIDQUERY : the companyID filter

*eventIDQUERY : the eventID filter

*personIDQUERY : the personID filter

*platformQUERY : the platform

*dateBeginQUERY : the date begin range

*dateEndQUERY : the date end range

*queryQUERY : the search query

Event

For each event, we can inform which people and activities are taking part in it. Each event receives an identifier, enabling to access its information, and to add new participantes or see its activities.

Models

{
    "Event": {
        "count": 1,
        "data": [
            {
                "eventID": "1",
                "name": "Aeronautic Engineering Week",
                "nickname": "sea2013",
                "email": "email@email.com",
                "description": "Aeronautic Engineering Week",
                "cover": "uploads\/1384178223.jpg",
                "dateBegin": "1376910000",
                "dateEnd": "1377302400",
                "latitude": "0",
                "longitude": "0",
                "spot": "",
                "address": "MIT",
                "city": "Cambridge",
                "state": "MA",
                "fugleman": "SAAero",
                "ticketURL": "1",
                "facebook": "",
                "twitter": "",
                "visible": "1",
                "public": "1",
                "automaticEnrollment": "1",
                "sandbox": "0",
                "approved": "-1"
            }
        ]
    }
}
{
    "approved": {
        "-1": "not registered",
        "0": "registered and not approved",
        "1": "registered and approved"
    }
}

Push Notification

event/edit

_event

Informs event eventID update.

{
    "eventID": "integer"
}

event/remove

_event

Informs event eventID removal.

{
    "eventID": "integer"
}

Methods

event.edit

( tokenID, eventID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.edit&tokenID=&eventID=&key=" \   -d "value="
$response = InEvent\Event::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : field name

{
    "name": "nome",
    "nickname": "hashtag",
    "email": "organization email",
    "description": "general introduction",
    "cover": "cover image",
    "dateBegin": "begin date",
    "dateEnd": "end date",
    "enrollmentBegin": "timestamp from begin of enrollment",
    "enrollmentEnd": "timestamp from end of enrollment",
    "latitude": "latitude",
    "longitude": "longitude",
    "address": "address on map",
    "fugleman": "organization name",
    "ticketURL": "gateway url",
    "website": "website url",
    "accessCode": "event access code",
    "facebook": "facebook page url",
    "twitter": "twitter profile url",
    "wireless": "wireless network information",
    "visible": "visible?",
    "public": "private?",
    "automaticEnrollment": "automatic enrollment?"
}

valueBODY : field value

{
    "name": "string",
    "nickname": "string",
    "email": "string",
    "description": "string",
    "cover": "string",
    "dateBegin": "timestamp",
    "dayBegin": "integer",
    "monthBegin": "integer",
    "hourBegin": "integer",
    "minuteBegin": "integer",
    "dateEnd": "timestamp",
    "dayEnd": "integer",
    "monthEnd": "integer",
    "hourEnd": "integer",
    "minuteEnd": "integer",
    "enrollmentBegin": "timestamp",
    "enrollmentEnd": "timestamp",
    "latitude": "integer",
    "longitude": "integer",
    "address": "string",
    "fugleman": "string",
    "ticketURL": "string",
    "website": "string",
    "accessCode": "1..9999",
    "facebook": "string",
    "twitter": "string",
    "wireless": "string",
    "visible": "integer(1)",
    "public": "integer(1)",
    "automaticEnrollment": "integer(1)"
}

event.get

( tokenID, eventID, personID, *quickLoad, *withCss )

  • Info
  • Curl
  • PHP
GET /api/?action=event.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.get&tokenID=&eventID=&personID="
$response = InEvent\Event::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Returns event eventID, informing if person personID is registered.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

*quickLoadQUERY : should load quickly

*withCssQUERY : should include custom css

( tokenID, eventID, *quickLoad, *withCss )

  • Info
  • Curl
  • PHP
GET /api/?action=event.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.get&tokenID=&eventID="
$response = InEvent\Event::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns event eventID, informing if person tokenID is registered.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*quickLoadQUERY : should load quickly

*withCssQUERY : should include custom css

( eventID, *quickLoad )

  • Info
  • Curl
  • PHP
GET /api/?action=event.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.get&eventID="
$response = InEvent\Event::get($client, [
  "eventID" => ""
]);

Returns event eventID.

eventIDQUERY : event identifier

*quickLoadQUERY : should load quickly

event.checkAccessCode

( tokenID, eventID, accessCode )

  • Info
  • Curl
  • PHP
POST /api/?action=event.checkAccessCodeHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.checkAccessCode&tokenID=&eventID=" \   -d "accessCode="
$response = InEvent\Event::checkAccessCode($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "accessCode" => ""
]);

Informs if access code is correct for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

accessCodeBODY : event access code

event.sendSMS

( eventID, telephone )

  • Info
  • Curl
  • PHP
POST /api/?action=event.sendSMSHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.sendSMS&eventID=" \   -d "telephone="
$response = InEvent\Event::sendSMS($client, [
  "eventID" => ""
], [
  "telephone" => ""
]);

Sends a SMS for person with telephone telephone at event eventID.

eventIDQUERY : event identifier

telephoneBODY : telephone number

event.search

( tokenID, eventID, query )

  • Info
  • Curl
  • PHP
POST /api/?action=event.searchHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.search&tokenID=&eventID=" \   -d "query="
$response = InEvent\Event::search($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "query" => ""
]);

Searchs generic objects inside the event.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

queryBODY : search to be performed

Event applicants

List all candidates willing to get access to the event but still haven't been able to do so, maybe due to payments, maybe regarging their credentials process or even specific business rules.

Models

{
    "count": 1,
    "data": [
        []
    ]
}

Methods

event.applicant.bind

( eventID, name, username, *password, *email, *role, *company, *telephone, *tagIDs )

  • Info
  • Curl
  • PHP
POST /api/?action=event.applicant.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.applicant.bind&eventID=" \   -d "name=&username="
$response = InEvent\Event.applicant::bind($client, [
  "eventID" => ""
], [
  "name" => "",
  "username" => ""
]);

Creates an application at event eventID.

eventIDQUERY : event identifier

nameBODY : person name

usernameBODY : person username

*passwordBODY : person password

*emailBODY : person email

*roleBODY : person role

*companyBODY : person company

*telephoneBODY : person telephone

*tagIDsBODY : list of tag ids

( eventID, name, email, password, *role, *company, *telephone, *tagIDs )

  • Info
  • Curl
  • PHP
POST /api/?action=event.applicant.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.applicant.bind&eventID=" \   -d "name=&email=&password="
$response = InEvent\Event.applicant::bind($client, [
  "eventID" => ""
], [
  "name" => "",
  "email" => "",
  "password" => ""
]);

Creates an application at event eventID.

eventIDQUERY : event identifier

nameBODY : person name

emailBODY : person email

passwordBODY : person password

*roleBODY : person role

*companyBODY : person company

*telephoneBODY : person telephone

*tagIDsBODY : list of tag ids

( tokenID, eventID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=event.applicant.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.applicant.bind&tokenID=&eventID=" \   -d "path="
$response = InEvent\Event.applicant::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "path" => ""
]);

Creates multiple applicants at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

pathBODY : file path

event.applicant.operate

( tokenID, eventID, firstName, lastName, email )

  • Info
  • Curl
  • PHP
POST /api/?action=event.applicant.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.applicant.operate&tokenID=&eventID=" \   -d "firstName=&lastName=&email="
$response = InEvent\Event.applicant::operate($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "firstName" => "",
  "lastName" => "",
  "email" => ""
]);

Changes an application at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

firstNameBODY : person first name

lastNameBODY : person last name

emailBODY : person email

( tokenID, eventID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=event.applicant.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.applicant.operate&tokenID=&eventID=" \   -d "content="
$response = InEvent\Event.applicant::operate($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Edits values content for person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : key values for editing

event.applicant.dismiss

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.applicant.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.applicant.dismiss&tokenID=&eventID=&personID="
$response = InEvent\Event.applicant::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Removes an applicant personID from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

event.applicant.find

( tokenID, eventID, *paginated, *query, *sort, *order )

  • Info
  • Curl
  • PHP
GET /api/?action=event.applicant.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.applicant.find&tokenID=&eventID="
$response = InEvent\Event.applicant::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Finds all aplications at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*paginatedQUERY : request to be paginated

*queryQUERY : search field

*sortQUERY : sort search

{
    "fullName": "Order by full name",
    "firstName": "Order by first name",
    "lastName": "Order by last name",
    "email": "Order by email",
    "personID": "Order by personID"
}

*orderQUERY : order search

{
    "ASC": "Order by ascending",
    "DESC": "Order by descending"
}

event.applicant.get

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.applicant.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.applicant.get&tokenID=&eventID=&personID="
$response = InEvent\Event.applicant::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Gathers an applicant personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.applicant.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.applicant.get&tokenID=&eventID="
$response = InEvent\Event.applicant::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers an application at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

event.applicant.approve

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.applicant.approveHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.applicant.approve&tokenID=&eventID=&personID="
$response = InEvent\Event.applicant::approve($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Approves an applicant personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

event.applicant.reject

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.applicant.rejectHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.applicant.reject&tokenID=&eventID=&personID="
$response = InEvent\Event.applicant::reject($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Rejects an applicant personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

Items reservation at event

For each event, partners can buy items inside your event, such as data collectors and beacons. It's necessary to fill a form and pay in order to authorize the sale.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "1",
            "value": "email@email.com",
            "source": "email",
            "used": "0"
        }
    ]
}

Methods

event.booking.create

( tokenID, eventID, name, email, telephone, company, dataCollectors, liveSupport, extraPhone, extraLive, automaticReport, beacons, pricing )

  • Info
  • Curl
  • PHP
POST /api/?action=event.booking.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.booking.create&tokenID=&eventID=" \   -d "name=&email=&telephone=&company=&dataCollectors=&liveSupport=&extraPhone=&extraLive=&automaticReport=&beacons=&pricing="
$response = InEvent\Event.booking::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "email" => "",
  "telephone" => "",
  "company" => "",
  "dataCollectors" => "",
  "liveSupport" => "",
  "extraPhone" => "",
  "extraLive" => "",
  "automaticReport" => "",
  "beacons" => "",
  "pricing" => ""
]);

Creates a reservation at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : client name

emailBODY : client email

telephoneBODY : client telephone

companyBODY : client company

dataCollectorsBODY : number of data collectors

liveSupportBODY : live support during the event

extraPhoneBODY : rented smartphone

extraLiveBODY : real-time leads base

automaticReportBODY : end of day automatic report

beaconsBODY : number of beacons

pricingBODY : sale price

event.booking.find

( tokenID, eventID, selection, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=event.booking.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.booking.find&tokenID=&eventID=&selection="
$response = InEvent\Event.booking::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Returns reservations at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : event reservations

{
    "all": "all reservations",
    "fresh": "new reservations",
    "used": "used reservations"
}

*queryQUERY : search text

event.booking.get

( tokenID, eventID, value )

  • Info
  • Curl
  • PHP
GET /api/?action=event.booking.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.booking.get&tokenID=&eventID=&value="
$response = InEvent\Event.booking::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "value" => ""
]);

Returns details from reservation value at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

valueQUERY : reservation identifier

Custom emails

Emails content sent on each moment can be customized. Each event can have only content type for each one of the available sources.

Models

{
    "count": 1,
    "data": [
        {
            "eventEmailID": "1",
            "eventID": "5927",
            "source": "eve",
            "text": "Thank you ...",
            "listID": "0",
            "date": "0",
            "sent": "0"
        }
    ]
}

Methods

event.email.create

( tokenID, eventID, subject, text, *listID )

  • Info
  • Curl
  • PHP
POST /api/?action=event.email.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.email.create&tokenID=&eventID=" \   -d "subject=&text="
$response = InEvent\Event.email::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "subject" => "",
  "text" => ""
]);

Creates a custom email with subject subject and text text at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

subjectBODY : email subject

textBODY : email content

*listIDBODY : list identifier

event.email.edit

( tokenID, eventID, source, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.email.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.email.edit&tokenID=&eventID=&source=&key=" \   -d "value="
$response = InEvent\Event.email::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "source" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key from source source at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sourceQUERY : email source

keyQUERY : field name

{
    "text": "content"
}

valueBODY : field value

{
    "text": "string"
}

event.email.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.email.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.email.find&tokenID=&eventID="
$response = InEvent\Event.email::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all emails from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

event.email.get

( tokenID, eventEmailID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.email.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.email.get&tokenID=&eventEmailID="
$response = InEvent\Event.email::get($client, [
  "tokenID" => "",
  "eventEmailID" => ""
]);

Returns email eventEmailID.

tokenIDQUERY : token identifier

eventEmailIDQUERY : email identifier

event.email.try

( tokenID, eventID, source )

  • Info
  • Curl
  • PHP
GET /api/?action=event.email.tryHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.email.try&tokenID=&eventID=&source="
$response = InEvent\Event.email::try($client, [
  "tokenID" => "",
  "eventID" => "",
  "source" => ""
]);

Sends a test email from source source to event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sourceQUERY : email source

event.email.dispatch

( tokenID, eventEmailID )

  • Info
  • Curl
  • PHP
POST /api/?action=event.email.dispatchHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.email.dispatch&tokenID=" \   -d "eventEmailID="
$response = InEvent\Event.email::dispatch($client, [
  "tokenID" => ""
], [
  "eventEmailID" => ""
]);

Sends an email eventEmailID to everyone in the event or list. Allowed only for custom emails.

tokenIDQUERY : token identifier

eventEmailIDBODY : email identifier at event

Emails blacklist

Blacklists are useful to ensure that people that decide to not receive any communication will have their right complied regarding all applicable legislations and privacy acts.

Models

{
    "count": 1,
    "data": [
        {
            "eventBlacklistID": "28962",
            "eventID": "6173",
            "email": "",
            "date": "1516294405"
        }
    ]
}

Methods

event.blacklist.remove

( tokenID, eventBlacklistID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.blacklist.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.blacklist.remove&tokenID=&eventBlacklistID="
$response = InEvent\Event.blacklist::remove($client, [
  "tokenID" => "",
  "eventBlacklistID" => ""
]);

Removes email eventBlacklistID.

tokenIDQUERY : token identifier

eventBlacklistIDQUERY : event email identifier

event.blacklist.find

( tokenID, eventID, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=event.blacklist.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.blacklist.find&tokenID=&eventID="
$response = InEvent\Event.blacklist::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all unsubscribed emails from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*queryQUERY : search text

Emails sanity

The emails sanity is verified taking use of AI and another attributes to ensure your email delivery and avoid SPAM.

Models

{
    "count": 1,
    "data": [
        {
            "eventSanityID": "28962",
            "eventID": "6173",
            "email": "",
            "clean": "1",
            "reason": "",
            "date": "1516294405"
        }
    ]
}

Methods

event.sanity.operate

( tokenID, eventSanityID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.sanity.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.sanity.operate&tokenID=&eventSanityID=&key=" \   -d "value="
$response = InEvent\Event.sanity::operate($client, [
  "tokenID" => "",
  "eventSanityID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key from email email.

tokenIDQUERY : token identifier

eventSanityIDQUERY : event email identifier

keyQUERY : field name

{
    "clean": "email risk"
}

valueBODY : field value

{
    "clean": "bit"
}

event.sanity.find

( tokenID, eventID, selection, *query, *sort, *order )

  • Info
  • Curl
  • PHP
GET /api/?action=event.sanity.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.sanity.find&tokenID=&eventID=&selection="
$response = InEvent\Event.sanity::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Returns all emails from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : search selection

{
    "all": "all emails",
    "safe-emails": "emails good for delivery",
    "spam-emails": "emails not allowed"
}

*queryQUERY : search text

*sortQUERY : sort query (email, clean, reason, date)

*orderQUERY : order query (ASC, DESC)

Event senders

Customize the email address signature for each specific person communications.

Models

{
    "count": 1,
    "data": [
        {
            "senderID": "1",
            "eventID": "1",
            "personID": "1",
            "senderName": "John",
            "senderEmail": "john@inevent.com",
            "senderDNS": "-1",
            "name": "Robert",
            "username": "robert@inevent.com"
        }
    ]
}

Methods

event.sender.edit

( tokenID, eventID, key, value, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=event.sender.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.sender.edit&tokenID=&eventID=&key=&personID=" \   -d "value="
$response = InEvent\Event.sender::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

Edits value value from field key for person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : element name

valueBODY : element value

personIDQUERY : person identifier

event.sender.find

( tokenID, eventID, selection, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=event.sender.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.sender.find&tokenID=&eventID=&selection="
$response = InEvent\Event.sender::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Returns signatures at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : event signatures

{
    "all": "all signatures"
}

*queryQUERY : search text

event.sender.get

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.sender.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.sender.get&tokenID=&eventID=&personID="
$response = InEvent\Event.sender::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Returns signature for personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

event.sender.refresh

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.sender.refreshHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.sender.refresh&tokenID=&eventID=&personID="
$response = InEvent\Event.sender::refresh($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Refreshes signature for personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

Event guests

Small corporate events may allow registrants to include guests in their registration, such as spouse, children, business partners, etc.

Models

{
    "count": 1,
    "data": [
        {
            "eventGuestID": "1",
            "personID": "1",
            "hostID": "1",
            "name": "Robert",
            "email": "robert@inevent.com",
            "date": "1234121151"
        }
    ]
}

Methods

event.guest.bind

( tokenID, eventID, hostID, name, *email )

  • Info
  • Curl
  • PHP
POST /api/?action=event.guest.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.guest.bind&tokenID=&eventID=&hostID=" \   -d "name="
$response = InEvent\Event.guest::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "hostID" => ""
], [
  "name" => ""
]);

Creates an guest at event eventID for host hostID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

hostIDQUERY : host identifier

nameBODY : guest name

*emailBODY : guest email

( tokenID, eventID, name, *email )

  • Info
  • Curl
  • PHP
POST /api/?action=event.guest.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.guest.bind&tokenID=&eventID=" \   -d "name="
$response = InEvent\Event.guest::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => ""
]);

Creates an guest at event eventID for host tokenID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : guest name

*emailBODY : guest email

event.guest.operate

( tokenID, eventID, personID, *hostID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.guest.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.guest.operate&tokenID=&eventID=&personID=&key=" \   -d "value="
$response = InEvent\Event.guest::operate($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key for guest personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : guest identifier

*hostIDQUERY : host identifier

keyQUERY : element name

valueBODY : desired action

( tokenID, eventID, personID, *hostID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=event.guest.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.guest.operate&tokenID=&eventID=&personID=" \   -d "content="
$response = InEvent\Event.guest::operate($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
], [
  "content" => ""
]);

Edits values content for guest personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : guest identifier

*hostIDQUERY : host identifier

contentBODY : key values for editing

event.guest.dismiss

( tokenID, eventID, personID, *hostID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.guest.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.guest.dismiss&tokenID=&eventID=&personID="
$response = InEvent\Event.guest::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Removes a guest personID from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : guest identifier

*hostIDQUERY : host identifier

event.guest.find

( tokenID, eventID, *paginated, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=event.guest.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.guest.find&tokenID=&eventID="
$response = InEvent\Event.guest::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Finds all guests at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*paginatedQUERY : request to be paginated

*queryQUERY : search field

event.guest.get

( tokenID, eventID, personID, *hostID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.guest.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.guest.get&tokenID=&eventID=&personID="
$response = InEvent\Event.guest::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Gathers a guest personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : guest identifier

*hostIDQUERY : host identifier

Event invites

For each event, we can invite people to register through our standard registration form.

Models

{
    "count": 1,
    "data": [
        {
            "inviteID": "1",
            "eventID": "1",
            "personID": "1",
            "inviteName": "Robert",
            "inviteEmail": "robert@inevent.com",
            "inviteRole": "CFO",
            "inviteCompany": "InEvent",
            "inviteTelephone": "",
            "used": "0",
            "rsvp": "-1",
            "name": "",
            "username": "robert@inevent.com",
            "assistantEmail": "john@inevent.com",
            "date": ""
        }
    ]
}

Methods

event.invite.create

( tokenID, eventID, email )

  • Info
  • Curl
  • PHP
POST /api/?action=event.invite.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.invite.create&tokenID=&eventID=" \   -d "email="
$response = InEvent\Event.invite::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "email" => ""
]);

Creates an invite at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

emailBODY : invite email

( tokenID, eventID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=event.invite.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.invite.create&tokenID=&eventID=" \   -d "path="
$response = InEvent\Event.invite::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "path" => ""
]);

Creates multiple invites at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

pathBODY : file path

event.invite.edit

( tokenID, eventID, key, value, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=event.invite.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.invite.edit&tokenID=&eventID=&key=&personID=" \   -d "value="
$response = InEvent\Event.invite::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

Edits value value from field key for person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : element name

valueBODY : desired action

personIDQUERY : person identifier

event.invite.remove

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.invite.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.invite.remove&tokenID=&eventID=&personID="
$response = InEvent\Event.invite::remove($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Removes person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

event.invite.find

( tokenID, eventID, selection, *query, *sort, *order )

  • Info
  • Curl
  • PHP
GET /api/?action=event.invite.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.invite.find&tokenID=&eventID=&selection="
$response = InEvent\Event.invite::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Returns invites at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : event invites

{
    "all": "all invites",
    "fresh": "new invites",
    "used": "used invites"
}

*queryQUERY : search text

*sortQUERY : search sort

{
    "id": "event identifier",
    "firstName": "first name",
    "lastName": "last name",
    "username": "username",
    "email": "email",
    "role": "position",
    "company": "company",
    "telephone": "phone",
    "assistantEmail": "assistant email",
    "rsvp": "confirmed, pending",
    "enrolled": "enrolled on event"
}

*orderQUERY : search order

{
    "DESC": "Order by descending",
    "ASC": "Order by ascending"
}

event.invite.get

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.invite.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.invite.get&tokenID=&eventID=&personID="
$response = InEvent\Event.invite::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Returns details of invite personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( eventID, email, *tracking )

  • Info
  • Curl
  • PHP
GET /api/?action=event.invite.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.invite.get&eventID=&email="
$response = InEvent\Event.invite::get($client, [
  "eventID" => "",
  "email" => ""
]);

Returns details of invite email at event eventID.

eventIDQUERY : event identifier

emailQUERY : invite email

*trackingQUERY : track form opens

event.invite.rsvp

( tokenID, eventID, email )

  • Info
  • Curl
  • PHP
GET /api/?action=event.invite.rsvpHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.invite.rsvp&tokenID=&eventID=&email="
$response = InEvent\Event.invite::rsvp($client, [
  "tokenID" => "",
  "eventID" => "",
  "email" => ""
]);

Updates rsvp for invite email at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

emailQUERY : invite email

( eventID, email )

  • Info
  • Curl
  • PHP
GET /api/?action=event.invite.rsvpHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.invite.rsvp&eventID=&email="
$response = InEvent\Event.invite::rsvp($client, [
  "eventID" => "",
  "email" => ""
]);

Updates rsvp for invite email at event eventID.

eventIDQUERY : event identifier

emailQUERY : invite email

Emails notification

Notifications are triggers sent to the event organizers when determined actions occur on the platform.

Models

{
    "count": 1,
    "data": [
        {
            "id": "1",
            "eventID": "6173",
            "memberID": "1",
            "applicantAdded": "0",
            "attendeeAdded": "1",
            "eventAlmostFull": "1",
            "eventCapacity": "1"
        }
    ]
}

Methods

event.notification.operate

( tokenID, eventID, key, value, *personID )

  • Info
  • Curl
  • PHP
POST /api/?action=event.notification.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.notification.operate&tokenID=&eventID=&key=" \   -d "value="
$response = InEvent\Event.notification::operate($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key for person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : field name

valueBODY : field value

*personIDQUERY : person identifier

event.notification.get

( tokenID, eventID, *personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.notification.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.notification.get&tokenID=&eventID="
$response = InEvent\Event.notification::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns notifications of person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*personIDQUERY : person identifier

Event attendees

For each event we can inform which people and activities are taking place inside of it. Add new people or seeing their activities, when with correct access permission, is simple.

Models

{
    "count": 1,
    "data": [
        {
            "personID": "1",
            "name": "Pedro Góes",
            "email": "email@email.com",
            "headline": "CEO @ InEvent",
            "image": "https:\/\/",
            "telephone": "+1 (999) 999 9999",
            "city": "New York",
            "facebookID": "0",
            "linkedInID": "0",
            "enrollmentID": "359",
            "approved": "1",
            "level": "1",
            "paid": "0",
            "present": "0",
            "private": "0"
        }
    ]
}
{
    "approved": {
        "-1": "not registered",
        "0": "registered and not approved",
        "1": "registered and approved"
    }
}
{
    "level": {
        "1": "LEVEL_USER",
        "4": "LEVEL_ADMIN"
    }
}

Methods

event.person.bind

( tokenID, eventID, name, username, *password, *role, *company, *accessCode )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.person.bind&tokenID=&eventID=" \   -d "name=&username="
$response = InEvent\Event.person::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "username" => ""
]);

Requests person with name name and user username to join event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : person name

usernameBODY : person username

*passwordBODY : person password

*roleBODY : person role

*companyBODY : person company

*accessCodeBODY : event access code

( eventID, invite, email, *name, *password, *role, *company, *rsvp )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.person.bind&eventID=" \   -d "invite=&email="
$response = InEvent\Event.person::bind($client, [
  "eventID" => ""
], [
  "invite" => "",
  "email" => ""
]);

Requests person with invite invite to join event eventID.

eventIDQUERY : event identifier

inviteBODY : access invite

emailBODY : person email

*nameBODY : person name

*passwordBODY : person password

*roleBODY : person role

*companyBODY : person company

*rsvpBODY : person rsvp

( tokenID, eventID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.person.bind&tokenID=&eventID=" \   -d "path="
$response = InEvent\Event.person::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "path" => ""
]);

Requests multiple people to join event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

pathBODY : file path

( tokenID, eventID, *accessCode )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.person.bind&tokenID=&eventID=" \   -d ""
$response = InEvent\Event.person::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [

]);

Requests person tokenID to join event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*accessCodeBODY : event access code

event.person.operate

( tokenID, eventID, key, value, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.person.operate&tokenID=&eventID=&key=&personID=" \   -d "value="
$response = InEvent\Event.person::operate($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

Edits value value from field key for person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : element name

{
    "private": "perfil invisible",
    "rsvp": "person rsvp",
    "present": "attendance on event",
    "level": "admin privilege",
    "meetingQuotaID": "meeting quota",
    "meetingAutoConfirm": "confirm meeting automatically"
}

valueBODY : desired action

{
    "private": "bit",
    "rsvp": "bit",
    "present": "bit",
    "level": "1: user | 4: admin | 9: collector",
    "meetingQuotaID": "integer(11)",
    "meetingAutoConfirm": "bit"
}

personIDQUERY : person identifier

( tokenID, eventID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.person.operate&tokenID=&eventID=&key=" \   -d "value="
$response = InEvent\Event.person::operate($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key for person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : element name

{
    "private": "invisible profile",
    "rsvp": "person rsvp",
    "present": "attendance on event"
}

valueBODY : desired action

{
    "private": "bit",
    "rsvp": "bit",
    "present": "bit"
}

( tokenID, eventID, content, *personID )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.person.operate&tokenID=&eventID=" \   -d "content="
$response = InEvent\Event.person::operate($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Edits values content for person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : array of key values for editing

{
    "key": "string",
    "value": "string"
}

*personIDQUERY : person identifier

event.person.dismiss

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.dismiss&tokenID=&eventID=&personID="
$response = InEvent\Event.person::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Requests removal of person personID from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID, content )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.dismiss&tokenID=&eventID=&content="
$response = InEvent\Event.person::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "content" => ""
]);

Requests removal of people content from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentQUERY : json formatted as [{personID}]

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.dismiss&tokenID=&eventID="
$response = InEvent\Event.person::dismiss($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Requests removal of person tokenID from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

event.person.find

( tokenID, eventID, selection, *order, *orderDirection, *query, *queryKey, *match, *fullProfile )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.find&tokenID=&eventID=&selection="
$response = InEvent\Event.person::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Returns everyone at event eventID, filtered by a selection selection and order order.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : people at event

{
    "all": "all events",
    "admin": "admins",
    "approved": "registration approved",
    "denied": "registration rejected",
    "downloaded": "application downloaded",
    "not-downloaded": "application not downloaded",
    "printed": "badges printed",
    "not-printed": "badges not printed",
    "safe-emails": "emails validated as safe",
    "spam-emails": "SPAM risk emails"
}

*orderQUERY : order based on column

*orderDirectionQUERY : order direction based on column

*queryQUERY : search text

*queryKeyQUERY : search key

*matchQUERY : exact match

*fullProfileQUERY : full profile for each person -- this will cap your results to 20.

( tokenID, eventID, selection, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.find&tokenID=&eventID=&selection="
$response = InEvent\Event.person::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Returns everyone at event eventID, filtered by a selection selection.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : people at event

*queryQUERY : search text

( tokenID, companyID, templates, selection, *order, *orderDirection )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.find&tokenID=&companyID=&templates=&selection="
$response = InEvent\Event.person::find($client, [
  "tokenID" => "",
  "companyID" => "",
  "templates" => "",
  "selection" => ""
]);

Returns everyone at events from template templateID at company companyID, filtered by a selection selection.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

templatesQUERY : list of template ids separated by commas

selectionQUERY : people at event

*orderQUERY : order based on column

*orderDirectionQUERY : order direction based on column

( tokenID, companyID, events, selection, *order, *orderDirection )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.find&tokenID=&companyID=&events=&selection="
$response = InEvent\Event.person::find($client, [
  "tokenID" => "",
  "companyID" => "",
  "events" => "",
  "selection" => ""
]);

Returns everyone at events from a list events at company companyID, filtered by a selection selection.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

eventsQUERY : list of event ids separated by commas

selectionQUERY : people at event

*orderQUERY : order based on column

*orderDirectionQUERY : order direction based on column

event.person.get

( tokenID, feedbackID, value )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.get&tokenID=&feedbackID=&value="
$response = InEvent\Event.person::get($client, [
  "tokenID" => "",
  "feedbackID" => "",
  "value" => ""
]);

Returns details of person with value value on field feedbackID.

tokenIDQUERY : token identifier

feedbackIDQUERY : field identifier

valueQUERY : field value

( tokenID, eventID, email )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.get&tokenID=&eventID=&email="
$response = InEvent\Event.person::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "email" => ""
]);

Returns details of person email at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

emailQUERY : person email

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.get&tokenID=&eventID=&personID="
$response = InEvent\Event.person::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Returns details of person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID, qrCode )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.get&tokenID=&eventID=&qrCode="
$response = InEvent\Event.person::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "qrCode" => ""
]);

Retuens details of person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

qrCodeQUERY : person qrCode

( tokenID, eventID, nfc )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.get&tokenID=&eventID=&nfc="
$response = InEvent\Event.person::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "nfc" => ""
]);

Returns details of person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nfcQUERY : person nfc wristband

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.get&tokenID=&eventID="
$response = InEvent\Event.person::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns details of person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

event.person.remember

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.rememberHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.remember&tokenID=&eventID="
$response = InEvent\Event.person::remember($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Sends email reminder for event eventID participants.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

event.person.qrCode

( tokenID, eventID, *query, *match )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.qrCodeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.qrCode&tokenID=&eventID="
$response = InEvent\Event.person::qrCode($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Generates all QR Codes for people at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*queryQUERY : search text

*matchQUERY : exact match

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.qrCodeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.qrCode&tokenID=&eventID=&personID="
$response = InEvent\Event.person::qrCode($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Generates all QR Codes of person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

event.person.print

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.printHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.print&tokenID=&eventID=&personID="
$response = InEvent\Event.person::print($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Informs that person personID QR code was printed at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

event.person.printed

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.printedHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.printed&tokenID=&eventID="
$response = InEvent\Event.person::printed($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns badges printed beyond cap at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

event.person.verifyEmail

( eventID, email, verifyEmailToken )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.verifyEmailHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.person.verifyEmail&eventID=&email=" \   -d "verifyEmailToken="
$response = InEvent\Event.person::verifyEmail($client, [
  "eventID" => "",
  "email" => ""
], [
  "verifyEmailToken" => ""
]);

Verifies if email is enrolled at event eventID.

eventIDQUERY : event identifier

emailQUERY : email

verifyEmailTokenBODY : token

event.person.requestMagicLink

( eventID, email, verifyEmailToken )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.requestMagicLinkHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.person.requestMagicLink&eventID=&email=" \   -d "verifyEmailToken="
$response = InEvent\Event.person::requestMagicLink($client, [
  "eventID" => "",
  "email" => ""
], [
  "verifyEmailToken" => ""
]);

Sends a magic link to enrolled person at eventID.

eventIDQUERY : event identifier

emailQUERY : email

verifyEmailTokenBODY : token

event.person.voucher

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.voucherHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.person.voucher&tokenID=&eventID="
$response = InEvent\Event.person::voucher($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Obtains voucher information for person at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

Event pipelines

Models

{
    "count": 1,
    "data": [
        {
            "personID": "1",
            "name": "Pedro Góes",
            "email": "email@email.com",
            "headline": "CEO @ InEvent",
            "image": "https:\/\/",
            "telephone": "+1 (999) 999 9999",
            "city": "San Francisco",
            "facebookID": "0",
            "linkedInID": "0",
            "enrollmentID": "359",
            "approved": "1",
            "level": "1",
            "paid": "0",
            "present": "0",
            "private": "0"
        }
    ]
}

Methods

event.pipeline.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.pipeline.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.pipeline.find&tokenID=&eventID="
$response = InEvent\Event.pipeline::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Obtains a pipeline for event eventID

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

Printer on event

Some events use printers to print participants badges.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "1",
            "type": "qr",
            "title": "name",
            "subtitle": "headline"
        }
    ]
}

Methods

event.printer.edit

( tokenID, eventID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.printer.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.printer.edit&tokenID=&eventID=&key=" \   -d "value="
$response = InEvent\Event.printer::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

Changes a field key with value value for printing at event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

keyQUERY : key to be changed

{
    "type": "print type",
    "title": "primary text",
    "subtitle": "secundary text"
}

valueBODY : key value

{
    "type": "0111-6111",
    "title": "name|role|company|headline",
    "subtitle": "name|role|company|headline"
}

event.printer.get

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.printer.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.printer.get&tokenID=&eventID="
$response = InEvent\Event.printer::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gets printing configuration for event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

Event Purchase

Purchase settings for event when enabled.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "1",
            "companyName": "",
            "companyTaxId": "",
            "addressLine1": "",
            "addressLine2": "",
            "paymentDetails": "",
            "refundPolicy": ""
        }
    ]
}

Methods

event.purchase.get

( eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.purchase.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.purchase.get&eventID="
$response = InEvent\Event.purchase::get($client, [
  "eventID" => ""
]);

Returns purchase information for event eventID.

eventIDQUERY : event identifier

event.purchase.setConfig

( tokenID, eventID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.purchase.setConfigHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.purchase.setConfig&tokenID=&eventID=&key=" \   -d "value="
$response = InEvent\Event.purchase::setConfig($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

Sets a config for purchase at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : company identifier

keyQUERY : field name

{
    "companyName": "the company name",
    "companyTaxId": "company registration id",
    "addressLine1": "company address line 1",
    "addressLine2": "company address line 2",
    "paymentDetails": "payment details",
    "refundPolicy": "refund policy (0 means no refund)"
}

valueBODY : field value

{
    "companyName": "text",
    "companyTaxId": "text",
    "addressLine1": "text",
    "addressLine2": "text",
    "paymentDetails": "text",
    "refundPolicy": "integer"
}

Event tabs

Particular applications need its tabs to contain different names / representations.

Models

{
    "count": 1,
    "data": [
        {
            "id": "1",
            "eventID": "1",
            "tab": "event",
            "text": "Event"
        }
    ]
}

Methods

event.tab.create

( tokenID, eventID, type, title, link )

  • Info
  • Curl
  • PHP
POST /api/?action=event.tab.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.tab.create&tokenID=&eventID=" \   -d "type=&title=&link="
$response = InEvent\Event.tab::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "type" => "",
  "title" => "",
  "link" => ""
]);

Creates title title with link link at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

typeBODY : tab type

titleBODY : tab title

linkBODY : tab link

event.tab.edit

( tokenID, eventID, tab, language, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.tab.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.tab.edit&tokenID=&eventID=&tab=&language=" \   -d "value="
$response = InEvent\Event.tab::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "tab" => "",
  "language" => ""
], [
  "value" => ""
]);

Edits value value from tab tab for language language at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

tabQUERY : tab name

{
    "event": "",
    "feed": "",
    "schedule": "",
    "networking": "",
    "notification": "",
    "more": "",
    "speaker": "",
    "photo": "",
    "sponsor": "",
    "material": ""
}

languageQUERY : language to be edited

valueBODY : tab text

event.tab.remove

( tokenID, eventTabID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tab.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.tab.remove&tokenID=&eventTabID="
$response = InEvent\Event.tab::remove($client, [
  "tokenID" => "",
  "eventTabID" => ""
]);

Removes tab eventTabID.

tokenIDQUERY : token identifier

eventTabIDQUERY : tab identifier

event.tab.find

( eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tab.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.tab.find&eventID="
$response = InEvent\Event.tab::find($client, [
  "eventID" => ""
]);

Returns all tabs from event eventID.

eventIDQUERY : event identifier

event.tab.get

( eventTabID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tab.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.tab.get&eventTabID="
$response = InEvent\Event.tab::get($client, [
  "eventTabID" => ""
]);

Returns tab eventTabID.

eventTabIDQUERY : tab identifier

Event tags

Tags associated with events, creating possibilities to determine interests from the event participants.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "1",
            "tagID": "1300"
        }
    ]
}

Methods

event.tag.bind

( tokenID, eventID, tagID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tag.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.tag.bind&tokenID=&eventID=&tagID="
$response = InEvent\Event.tag::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "tagID" => ""
]);

Links tag tagID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

tagIDQUERY : tag identifier

event.tag.dismiss

( tokenID, eventID, tagID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tag.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.tag.dismiss&tokenID=&eventID=&tagID="
$response = InEvent\Event.tag::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "tagID" => ""
]);

Unlinks tag tagID from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

tagIDQUERY : tag identifier

event.tag.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tag.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.tag.find&tokenID=&eventID="
$response = InEvent\Event.tag::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all event eventID tags.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

( eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tag.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.tag.find&eventID="
$response = InEvent\Event.tag::find($client, [
  "eventID" => ""
]);

Returns all event eventID tags.

eventIDQUERY : event identifier

Event themes

Themes are essential on finding an event. They help to define the event's flavor, creating its own identity and categories.

Methods

event.theme.operate

( tokenID, eventID, operation, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.theme.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.theme.operate&tokenID=&eventID=&operation=&key=" \   -d "value="
$response = InEvent\Event.theme::operate($client, [
  "tokenID" => "",
  "eventID" => "",
  "operation" => "",
  "key" => ""
], [
  "value" => ""
]);

Sends operation operation to value value on field key at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

operationQUERY : desired action

{
    "add": "add new themes to event",
    "remove": "remove themes from event"
}

keyQUERY : element type

{
    "theme": "theme name",
    "themeID": "theme identifier"
}

valueBODY : field value

{
    "theme": "string",
    "themeID": "integer"
}

Event tools

Each event contains exclusive tools which can be controlled by its admins.

Models

{
    "count": 1,
    "data": [
        {
            "id": "1",
            "eventID": "1",
            "presence": "0"
        }
    ]
}

Methods

event.tool.edit

( tokenID, eventID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.tool.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=event.tool.edit&tokenID=&eventID=&key=" \   -d "value="
$response = InEvent\Event.tool::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : element name

valueBODY : element value

event.tool.get

( eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tool.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=event.tool.get&eventID="
$response = InEvent\Event.tool::get($client, [
  "eventID" => ""
]);

Returns all tools available at event eventID.

eventIDQUERY : event identifier

Eventbrite

Module destinated to integration between InEvent events and Eventbrite events.

Methods

eventbrite.get

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=eventbrite.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=eventbrite.get&tokenID=&eventID="
$response = InEvent\Eventbrite::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Obtains integration data from Eventbrite with event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

eventbrite.linkField

( tokenID, eventID, feedbackID, ebFieldID )

  • Info
  • Curl
  • PHP
POST /api/?action=eventbrite.linkFieldHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=eventbrite.linkField&tokenID=&eventID=" \   -d "feedbackID=&ebFieldID="
$response = InEvent\Eventbrite::linkField($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "feedbackID" => "",
  "ebFieldID" => ""
]);

Links a field feedbackID from event eventID registration form with a Eventbrite field ebFieldID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

feedbackIDBODY : InEvent field identifier

ebFieldIDBODY : Eventbrite field identifier

Facebook

The content below refers to operations about the social network Facebook. The data obtained from it are not that useful as the ones from LinkedIn, but the possibility to use a higher volume contacts network is interesting to correlate some professional interests. The needed permissions to be requested are email, name and picture.

Methods

facebook.signIn

( facebookToken )

  • Info
  • Curl
  • PHP
GET /api/?action=facebook.signInHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=facebook.signIn&facebookToken="
$response = InEvent\Facebook::signIn($client, [
  "facebookToken" => ""
]);

Starts a session from a person, based on token facebookToken.

facebookTokenQUERY : authentication token given by Facebook

Feed

A stream of posts that can be published by the organization or directly inside the app. Beyond that, it is possible for users to interact with published contents.

Models

{
    "count": 1,
    "data": [
        {
            "feedID": "4",
            "companyID": "1",
            "eventID": "1242",
            "memberID": "4242",
            "title": "Welcome to title",
            "text": "Great to have you!",
            "picture": "",
            "video": "",
            "actionTitle": "",
            "actionUrl": "",
            "externalTitle": "",
            "externalPicture": "",
            "externalUrl": "",
            "shares": "",
            "date": ""
        }
    ]
}

Push Notification

feed/comment

_feed

Notifies that person personID commented on your post or in any post that you interacted with.

{
    "eventID": "integer",
    "personID": "integer"
}

feed/like

_feed

Notifies that person personID liked your post.

{
    "eventID": "integer",
    "personID": "integer"
}

Methods

feed.create

( tokenID, eventID, text, *picture, *video, *externalUrl )

  • Info
  • Curl
  • PHP
POST /api/?action=feed.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feed.create&tokenID=&eventID=" \   -d "text="
$response = InEvent\Feed::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "text" => ""
]);

Creates a post with contents text at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

textBODY : post contents

*pictureBODY : picture url

*videoBODY : video url

*externalUrlBODY : url for an external resource

feed.edit

( tokenID, feedID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=feed.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feed.edit&tokenID=&feedID=&key=" \   -d "value="
$response = InEvent\Feed::edit($client, [
  "tokenID" => "",
  "feedID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits a field of post feedID.

tokenIDQUERY : token identifier

feedIDQUERY : post identifier

keyQUERY : field name

valueBODY : field value

feed.remove

( tokenID, feedID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feed.remove&tokenID=&feedID="
$response = InEvent\Feed::remove($client, [
  "tokenID" => "",
  "feedID" => ""
]);

Removes post feedID.

tokenIDQUERY : token identifier

feedIDQUERY : post identifier

feed.find

( tokenID, eventID, selection, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feed.find&tokenID=&eventID=&selection="
$response = InEvent\Feed::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Returns all posts for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : selection scope

{
    "all": "all posts",
    "approved+me": "approved posts and your posts"
}

*queryQUERY : query text

( eventID, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feed.find&eventID="
$response = InEvent\Feed::find($client, [
  "eventID" => ""
]);

Returns all public posts for event eventID.

eventIDQUERY : event identifier

*queryQUERY : query text

feed.get

( tokenID, feedID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feed.get&tokenID=&feedID="
$response = InEvent\Feed::get($client, [
  "tokenID" => "",
  "feedID" => ""
]);

Returns post feedID.

tokenIDQUERY : token identifier

feedIDQUERY : post identifier

feed.share

( tokenID, feedID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.shareHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feed.share&tokenID=&feedID="
$response = InEvent\Feed::share($client, [
  "tokenID" => "",
  "feedID" => ""
]);

Shares post feedID.

tokenIDQUERY : token identifier

feedIDQUERY : post identifier

feed.like

( tokenID, feedID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.likeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feed.like&tokenID=&feedID="
$response = InEvent\Feed::like($client, [
  "tokenID" => "",
  "feedID" => ""
]);

Likes post feedID.

tokenIDQUERY : token identifier

feedIDQUERY : post identifier

feed.unlike

( tokenID, feedID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.unlikeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feed.unlike&tokenID=&feedID="
$response = InEvent\Feed::unlike($client, [
  "tokenID" => "",
  "feedID" => ""
]);

Unlikes post feedID.

tokenIDQUERY : token identifier

feedIDQUERY : post identifier

feed.report

( tokenID, feedID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.reportHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feed.report&tokenID=&feedID="
$response = InEvent\Feed::report($client, [
  "tokenID" => "",
  "feedID" => ""
]);

Reports post feedID as inappropriate.

tokenIDQUERY : token identifier

feedIDQUERY : post identifier

feed.preview

( tokenID, eventID, url )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.previewHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feed.preview&tokenID=&eventID=&url="
$response = InEvent\Feed::preview($client, [
  "tokenID" => "",
  "eventID" => "",
  "url" => ""
]);

Generates a preview for link url at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

urlQUERY : preview link

Post comments

In each feed post there is the possibility to comment on it.

Models

{
    "count": 1,
    "data": [
        {
            "feedCommentID": "3",
            "feedID": "5",
            "memberID": "1",
            "text": "Hello World",
            "date": "666111666"
        }
    ]
}

Methods

feed.comment.create

( tokenID, feedID, text )

  • Info
  • Curl
  • PHP
POST /api/?action=feed.comment.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feed.comment.create&tokenID=&feedID=" \   -d "text="
$response = InEvent\Feed.comment::create($client, [
  "tokenID" => "",
  "feedID" => ""
], [
  "text" => ""
]);

Creates a new comment with contents text at post feedID.

tokenIDQUERY : token identifier

feedIDQUERY : feed identifier

textBODY : comment text

feed.comment.edit

( tokenID, feedCommentID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=feed.comment.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feed.comment.edit&tokenID=&feedCommentID=&key=" \   -d "value="
$response = InEvent\Feed.comment::edit($client, [
  "tokenID" => "",
  "feedCommentID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of comment feedCommentID.

tokenIDQUERY : token identifier

feedCommentIDQUERY : comment identifier

keyQUERY : field name

valueBODY : field value

feed.comment.remove

( tokenID, feedCommentID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.comment.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feed.comment.remove&tokenID=&feedCommentID="
$response = InEvent\Feed.comment::remove($client, [
  "tokenID" => "",
  "feedCommentID" => ""
]);

Removes comment feedCommentID.

tokenIDQUERY : token identifier

feedCommentIDQUERY : comment identifier

feed.comment.find

( tokenID, feedID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.comment.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feed.comment.find&tokenID=&feedID="
$response = InEvent\Feed.comment::find($client, [
  "tokenID" => "",
  "feedID" => ""
]);

Gathers all post feedID comments.

tokenIDQUERY : token identifier

feedIDQUERY : feed identifier

feed.comment.report

( tokenID, feedCommentID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.comment.reportHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feed.comment.report&tokenID=&feedCommentID="
$response = InEvent\Feed.comment::report($client, [
  "tokenID" => "",
  "feedCommentID" => ""
]);

Reports a comment feedCommentID as inappropriate.

tokenIDQUERY : token identifier

feedCommentIDQUERY : comment identifier

Feedback

Feedback forms are questionnaires with several questions to evaluate something. For each feedback, it is possible to retrieve different kinds of data. This API is used for custom fields and forms as well.

Models

{
    "count": 1,
    "data": [
        {
            "feedbackID": "5",
            "eventID": "3",
            "activityID": "3",
            "text": "Question",
            "subtitle": "Subtitle",
            "type": "text",
            "value": "0",
            "preQualify": "0",
            "required": "0",
            "members": [
                {
                    "personID": "5",
                    "personName": "Pedro Góes",
                    "value": "1"
                }
            ]
        }
    ]
}

Push Notification

feedback/event.create

_event

Notifies creation of new feedback questionnaire for event eventID.

{
    "eventID": "integer"
}

feedback/activity.create

_activity

Notifies creation of new feedback questionnaire for activity activityID.

{
    "activityID": "integer"
}

Methods

feedback.create

( tokenID, eventID, text, *subtitle, type, *preQualify )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feedback.create&tokenID=&eventID=" \   -d "text=&type="
$response = InEvent\Feedback::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "text" => "",
  "type" => ""
]);

Creates a new feedback at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

textBODY : feedback text

*subtitleBODY : feedback subtitle

typeBODY : feedback type

{
    "type": "string(bool|integer|text|multiple|select)"
}

*preQualifyBODY : pre-qualify

( tokenID, activityID, text, *subtitle, type )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feedback.create&tokenID=&activityID=" \   -d "text=&type="
$response = InEvent\Feedback::create($client, [
  "tokenID" => "",
  "activityID" => ""
], [
  "text" => "",
  "type" => ""
]);

Creates a new feedback at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

textBODY : feedback text

*subtitleBODY : feedback subtitle

typeBODY : feedback type

{
    "type": "string(bool|integer|text|multiple|select)"
}

( tokenID, meetingID, text, *subtitle, type )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feedback.create&tokenID=&meetingID=" \   -d "text=&type="
$response = InEvent\Feedback::create($client, [
  "tokenID" => "",
  "meetingID" => ""
], [
  "text" => "",
  "type" => ""
]);

Creates a new feedback at meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

textBODY : feedback text

*subtitleBODY : feedback subtitle

typeBODY : feedback type

{
    "type": "string(bool|integer|text|multiple|select)"
}

( tokenID, formID, text, *subtitle, type )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feedback.create&tokenID=&formID=" \   -d "text=&type="
$response = InEvent\Feedback::create($client, [
  "tokenID" => "",
  "formID" => ""
], [
  "text" => "",
  "type" => ""
]);

Creates a new feedback at form formID.

tokenIDQUERY : token identifier

formIDQUERY : form identifier

textBODY : feedback text

*subtitleBODY : feedback subtitle

typeBODY : feedback type

{
    "type": "string(bool|integer|text|multiple|select)"
}

feedback.edit

( tokenID, feedbackID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feedback.edit&tokenID=&feedbackID=&key=" \   -d "value="
$response = InEvent\Feedback::edit($client, [
  "tokenID" => "",
  "feedbackID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of feedback feedbackID.

tokenIDQUERY : token identifier

feedbackIDQUERY : feedback identifier

keyQUERY : field name

{
    "text": "text",
    "subtitle": "subtitle",
    "type": "type",
    "preQualify": "initial flow",
    "required": "is it required"
}

valueBODY : field value

{
    "text": "string",
    "subtitle": "string",
    "type": "string(bool|integer|text|multiple|select)",
    "preQualify": "bit",
    "required": "bit"
}

feedback.remove

( tokenID, feedbackID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.remove&tokenID=&feedbackID="
$response = InEvent\Feedback::remove($client, [
  "tokenID" => "",
  "feedbackID" => ""
]);

Removes feedback feedbackID.

tokenIDQUERY : token identifier

feedbackIDQUERY : feedback identifier

feedback.find

( tokenID, eventID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.find&tokenID=&eventID=&selection="
$response = InEvent\Feedback::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Gathers all pieces of feedback posted at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : feedback scope

{
    "preQualify": "pre-qualify feedback",
    "event": "event feedback",
    "event+activities": "event feedback and activities",
    "event+preQualify": "event feedback and pre-qualify",
    "registration": "event registration form",
    "guest": "event guest registration form",
    "registration-guest": "event registration form",
    "event-all": "event feedback"
}

( eventID, selection, invite )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.find&eventID=&selection=&invite="
$response = InEvent\Feedback::find($client, [
  "eventID" => "",
  "selection" => "",
  "invite" => ""
]);

Gathers all feedback posted at event eventID.

eventIDQUERY : event identifier

selectionQUERY : feedback scope

inviteQUERY : invite field

( eventID, selection, ticketToken )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.find&eventID=&selection=&ticketToken="
$response = InEvent\Feedback::find($client, [
  "eventID" => "",
  "selection" => "",
  "ticketToken" => ""
]);

Gathers all feedback posted at event eventID.

eventIDQUERY : event identifier

selectionQUERY : feedback scope

ticketTokenQUERY : ticket token identifier

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.find&tokenID=&activityID="
$response = InEvent\Feedback::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Gathers all feedback posted at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

( tokenID, meetingID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.find&tokenID=&meetingID="
$response = InEvent\Feedback::find($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Gathers all feedback posted at meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

( tokenID, formID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.find&tokenID=&formID="
$response = InEvent\Feedback::find($client, [
  "tokenID" => "",
  "formID" => ""
]);

Gathers all feedback posted at form formID.

tokenIDQUERY : token identifier

formIDQUERY : form identifier

feedback.get

( tokenID, feedbackID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.get&tokenID=&feedbackID="
$response = InEvent\Feedback::get($client, [
  "tokenID" => "",
  "feedbackID" => ""
]);

Gathers feedback feedbackID.

tokenIDQUERY : token identifier

feedbackIDQUERY : feedback identifier

feedback.pushNotification

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.pushNotificationHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.pushNotification&tokenID=&activityID="
$response = InEvent\Feedback::pushNotification($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Sends a notification for all attendees of activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.pushNotificationHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.pushNotification&tokenID=&eventID="
$response = InEvent\Feedback::pushNotification($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Sends a notification for all attendees of event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

feedback.respond

( tokenID, eventID, content, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.respondHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feedback.respond&tokenID=&eventID=&personID=" \   -d "content="
$response = InEvent\Feedback::respond($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
], [
  "content" => ""
]);

Answers single or several feedback at event eventID for person personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : JSON content

[
    {
        "feedbackID": "integer",
        "value": "string or array (if feedback.type = 'multiple')"
    }
]

personIDQUERY : person identifier

( tokenID, eventID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.respondHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feedback.respond&tokenID=&eventID=" \   -d "content="
$response = InEvent\Feedback::respond($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Answers single or several feedback at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : JSON content

[
    {
        "feedbackID": "integer",
        "value": "string or array (if feedback.type = 'multiple')"
    }
]

( eventID, content, invite )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.respondHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feedback.respond&eventID=&invite=" \   -d "content="
$response = InEvent\Feedback::respond($client, [
  "eventID" => "",
  "invite" => ""
], [
  "content" => ""
]);

Answers single or several feedback at event eventID for person invite.

eventIDQUERY : event identifier

contentBODY : JSON content

[
    {
        "feedbackID": "integer",
        "value": "string or array (if feedback.type = 'multiple')"
    }
]

inviteQUERY : invite field

( eventID, content, personID, password )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.respondHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feedback.respond&eventID=&personID=" \   -d "content=&password="
$response = InEvent\Feedback::respond($client, [
  "eventID" => "",
  "personID" => ""
], [
  "content" => "",
  "password" => ""
]);

Answers single or several feedback at event eventID for person personID with password.

eventIDQUERY : event identifier

contentBODY : JSON content

[
    {
        "feedbackID": "integer",
        "value": "string or array (if feedback.type = 'multiple')"
    }
]

personIDQUERY : person identifier

passwordBODY : person password

Feedback options

Feedback may require a specific set of answers like a select box or a multiple choice element.

Models

{
    "count": 1,
    "data": [
        {
            "feedbackOptionID": "3",
            "feedbackID": "5",
            "text": "Biscuit"
        },
        {
            "feedbackOptionID": "4",
            "feedbackID": "5",
            "text": "Cracker"
        }
    ]
}

Methods

feedback.option.create

( tokenID, feedbackID, text )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.option.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feedback.option.create&tokenID=&feedbackID=" \   -d "text="
$response = InEvent\Feedback.option::create($client, [
  "tokenID" => "",
  "feedbackID" => ""
], [
  "text" => ""
]);

Creates a new option at feedback feedbackID.

tokenIDQUERY : token identifier

feedbackIDQUERY : feedback identifier

textBODY : feedback text

feedback.option.edit

( tokenID, feedbackOptionID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.option.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=feedback.option.edit&tokenID=&feedbackOptionID=&key=" \   -d "value="
$response = InEvent\Feedback.option::edit($client, [
  "tokenID" => "",
  "feedbackOptionID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of feedback option feedbackOptionID.

tokenIDQUERY : token identifier

feedbackOptionIDQUERY : feedback option identifier

keyQUERY : field name

{
    "text": "answer"
}

valueBODY : field value

{
    "text": "string"
}

feedback.option.remove

( tokenID, feedbackOptionID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.option.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.option.remove&tokenID=&feedbackOptionID="
$response = InEvent\Feedback.option::remove($client, [
  "tokenID" => "",
  "feedbackOptionID" => ""
]);

Removes feedback option feedbackOptionID.

tokenIDQUERY : token identifier

feedbackOptionIDQUERY : feedback option identifier

feedback.option.find

( tokenID, feedbackID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.option.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.option.find&tokenID=&feedbackID="
$response = InEvent\Feedback.option::find($client, [
  "tokenID" => "",
  "feedbackID" => ""
]);

Gathers all options for feedback feedbackID.

tokenIDQUERY : token identifier

feedbackIDQUERY : feedback identifier

feedback.option.get

( tokenID, feedbackOptionID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.option.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.option.get&tokenID=&feedbackOptionID="
$response = InEvent\Feedback.option::get($client, [
  "tokenID" => "",
  "feedbackOptionID" => ""
]);

Gathers feedback option feedbackOptionID.

tokenIDQUERY : token identifier

feedbackOptionIDQUERY : feedback option identifier

feedback.option.clear

( tokenID, feedbackID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.option.clearHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.option.clear&tokenID=&feedbackID="
$response = InEvent\Feedback.option::clear($client, [
  "tokenID" => "",
  "feedbackID" => ""
]);

Removes all feedback feedbackID options.

tokenIDQUERY : token identifier

feedbackIDQUERY : feedback identifier

Feedback submissions

List of submissions for a group of feedback.

Models

{
    "count": 1,
    "data": [
        {
            "feedbackSubmissionID": "3",
            "personID": "5",
            "status": "submitted",
            "answers": [],
            "data": "1212512"
        }
    ]
}

Methods

feedback.submission.find

( tokenID, eventID, *selection, *paginated )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.submission.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.submission.find&tokenID=&eventID="
$response = InEvent\Feedback.submission::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all feedback submissions for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*selectionQUERY : selection identifier

*paginatedQUERY : should be paginated

( tokenID, activityID, *paginated )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.submission.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.submission.find&tokenID=&activityID="
$response = InEvent\Feedback.submission::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Gathers all feedback submissions for activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

*paginatedQUERY : should be paginated

( tokenID, formID, *paginated )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.submission.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.submission.find&tokenID=&formID="
$response = InEvent\Feedback.submission::find($client, [
  "tokenID" => "",
  "formID" => ""
]);

Gathers all feedback submissions for form formID.

tokenIDQUERY : token identifier

formIDQUERY : form identifier

*paginatedQUERY : should be paginated

feedback.submission.get

( tokenID, feedbackSubmissionID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.submission.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=feedback.submission.get&tokenID=&feedbackSubmissionID="
$response = InEvent\Feedback.submission::get($client, [
  "tokenID" => "",
  "feedbackSubmissionID" => ""
]);

Gathers a feedback submission feedbackSubmissionID.

tokenIDQUERY : token identifier

feedbackSubmissionIDQUERY : feedback submission identifier

File

Cloud storage of files, in a secure and reliable environment. Every file created has its on public shuffled url. Files must be sent using content-type of application/octet-stream

Methods

file.create

( tokenID, companyID, name, file, width, height )

  • Info
  • Curl
  • PHP
POST /api/?action=file.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=file.create&tokenID=&companyID=&name=&width=&height=" \   -d "file="
$response = InEvent\File::create($client, [
  "tokenID" => "",
  "companyID" => "",
  "name" => "",
  "width" => "",
  "height" => ""
], [
  "file" => ""
]);

Creates and process a file named name with size width by height at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

nameQUERY : file name

fileBODY : binary file

widthQUERY : image width

heightQUERY : image height

( onboardingToken, name, width, height, file )

  • Info
  • Curl
  • PHP
POST /api/?action=file.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=file.create&onboardingToken=&name=&width=&height=" \   -d "file="
$response = InEvent\File::create($client, [
  "onboardingToken" => "",
  "name" => "",
  "width" => "",
  "height" => ""
], [
  "file" => ""
]);

Creates and process a file named name with size width by height.

onboardingTokenQUERY : token de onboarding

nameQUERY : file name

widthQUERY : image width

heightQUERY : image height

fileBODY : binary file

file.crop

( tokenID, companyID, url, width, height, xpos, ypos )

  • Info
  • Curl
  • PHP
GET /api/?action=file.cropHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=file.crop&tokenID=&companyID=&url=&width=&height=&xpos=&ypos="
$response = InEvent\File::crop($client, [
  "tokenID" => "",
  "companyID" => "",
  "url" => "",
  "width" => "",
  "height" => "",
  "xpos" => "",
  "ypos" => ""
]);

Crops an image.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

urlQUERY : file name

widthQUERY : file width

heightQUERY : file height

xposQUERY : crop x pos

yposQUERY : crop y pos

Flight

Events may provide flights for their attendees and manage all of their costs.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "",
            "personID": "",
            "airline": "",
            "number": "",
            "gate": "",
            "airportBegin": "",
            "airportEnd": "",
            "dateBegin": "",
            "dateEnd": "",
            "price": "",
            "eTicket": "",
            "date": "1415152800"
        }
    ]
}

Methods

flight.create

( tokenID, eventID, personID, airline, number, gate, seat, ticketType, airportBegin, airportEnd, dateBegin, dateEnd, dateIssue, *price, *priceConversion, *insurance, *eTicket, *confirmation, *message )

  • Info
  • Curl
  • PHP
POST /api/?action=flight.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=flight.create&tokenID=&eventID=&personID=" \   -d "airline=&number=&gate=&seat=&ticketType=&airportBegin=&airportEnd=&dateBegin=&dateEnd=&dateIssue="
$response = InEvent\Flight::create($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
], [
  "airline" => "",
  "number" => "",
  "gate" => "",
  "seat" => "",
  "ticketType" => "",
  "airportBegin" => "",
  "airportEnd" => "",
  "dateBegin" => "",
  "dateEnd" => "",
  "dateIssue" => ""
]);

Creates a flight entry at event eventID for person personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

airlineBODY : airline company

numberBODY : flight number

gateBODY : flight gate

seatBODY : flight seat

ticketTypeBODY : ticket type

airportBeginBODY : airport of departure

airportEndBODY : airport of arrival

dateBeginBODY : date and time of departure

dateEndBODY : date and time of arrival

dateIssueBODY : ticket issue date

*priceBODY : flight price

*priceConversionBODY : price conversion

*insuranceBODY : insurance agency

*eTicketBODY : electronic ticket

*confirmationBODY : confirmation code

*messageBODY : custom messages

( tokenID, eventID, email, airline, number, gate, ticketType, airportBegin, airportEnd, dateBegin, dateEnd, dateIssue, *price, *priceConversion, *insurance, *eTicket, *confirmation, *message )

  • Info
  • Curl
  • PHP
POST /api/?action=flight.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=flight.create&tokenID=&eventID=" \   -d "email=&airline=&number=&gate=&ticketType=&airportBegin=&airportEnd=&dateBegin=&dateEnd=&dateIssue="
$response = InEvent\Flight::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "email" => "",
  "airline" => "",
  "number" => "",
  "gate" => "",
  "ticketType" => "",
  "airportBegin" => "",
  "airportEnd" => "",
  "dateBegin" => "",
  "dateEnd" => "",
  "dateIssue" => ""
]);

Creates a flight entry at event eventID for person email.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

emailBODY : email da pessoa

airlineBODY : airline company

numberBODY : flight number

gateBODY : flight gate

ticketTypeBODY : ticket type

airportBeginBODY : airport of departure

airportEndBODY : airport of arrival

dateBeginBODY : date and time of departure

dateEndBODY : date and time of arrival

dateIssueBODY : ticket issue date

*priceBODY : flight price

*priceConversionBODY : price conversion

*insuranceBODY : insurance agency

*eTicketBODY : electronic ticket

*confirmationBODY : confirmation code

*messageBODY : custom messages

( tokenID, eventID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=flight.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=flight.create&tokenID=&eventID=" \   -d "path="
$response = InEvent\Flight::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "path" => ""
]);

Creates multiple flights at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

pathBODY : file path

flight.edit

( tokenID, flightID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=flight.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=flight.edit&tokenID=&flightID=&key=" \   -d "value="
$response = InEvent\Flight::edit($client, [
  "tokenID" => "",
  "flightID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of flight flightID.

tokenIDQUERY : token identifier

flightIDQUERY : flight identifier

keyQUERY : field name

{
    "personID": "person identifier",
    "airline": "data",
    "number": "data",
    "gate": "data",
    "seat": "data",
    "ticketType": "data",
    "airportBegin": "data",
    "airportEnd": "data",
    "dateBegin": "data",
    "dateEnd": "data",
    "dateIssue": "data",
    "price": "data",
    "priceConversion": "data",
    "insurance": "data",
    "eTicket": "data",
    "confirmation": "data"
}

valueBODY : field value

{
    "personID": "person identifier",
    "airline": "data",
    "number": "data",
    "gate": "data",
    "seat": "data",
    "ticketType": "data",
    "airportBegin": "data",
    "airportEnd": "data",
    "dateBegin": "data",
    "dateEnd": "data",
    "dateIssue": "data",
    "price": "data",
    "priceConversion": "data",
    "insurance": "data",
    "eTicket": "data",
    "confirmation": "data"
}

flight.remove

( tokenID, flightID )

  • Info
  • Curl
  • PHP
GET /api/?action=flight.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=flight.remove&tokenID=&flightID="
$response = InEvent\Flight::remove($client, [
  "tokenID" => "",
  "flightID" => ""
]);

Removes flight flightID from event.

tokenIDQUERY : token identifier

flightIDQUERY : flight identifier

flight.find

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=flight.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=flight.find&tokenID=&eventID=&personID="
$response = InEvent\Flight::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Gathers all flights of person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID, *selection, *query, *queryKey )

  • Info
  • Curl
  • PHP
GET /api/?action=flight.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=flight.find&tokenID=&eventID="
$response = InEvent\Flight::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all flights from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*selectionQUERY : specific selection

{
    "all": "all flights"
}

*queryQUERY : query text

*queryKeyQUERY : query key

flight.stats

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=flight.statsHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=flight.stats&tokenID=&eventID="
$response = InEvent\Flight::stats($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all flight statistics at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

Flow

For all interactions that occurs during the event, it is necessary to send notifications. For each object, it type allows developers to disguise their types. It is also sent a specific date for each object so developers can identify when they were created or updated.

Models

{
    "count": 1,
    "data": [
        {
            "type": {
                "activity": "current activity",
                "news": "important news",
                "question": "live questions",
                "feedback": "live feedback"
            },
            "timestamp": "object date"
        }
    ]
}

Methods

flow.find

( tokenID, eventID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=flow.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=flow.find&tokenID=&eventID=&selection="
$response = InEvent\Flow::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Gathers interactions flow for person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : feed type

{
    "internal": "all notifications"
}

Form

Forms are a great way to obtain information from attendees, new applicants, ticket sales, event briefings, supplier briefings, and a lot more.

Models

{
    "count": 1,
    "data": [
        {
            "formID": "5",
            "eventID": "3",
            "title": "Initial form",
            "description": "message flow",
            "date": "1241241512",
            "feedbacks": [
                {
                    "feedbackID": "5",
                    "eventID": "3",
                    "activityID": "3",
                    "text": "Question",
                    "type": "text",
                    "value": "0",
                    "preQualify": "0",
                    "required": "0",
                    "members": [
                        {
                            "personID": "5",
                            "personName": "Pedro Góes",
                            "value": "1"
                        }
                    ]
                }
            ]
        }
    ]
}

Methods

form.create

( tokenID, companyID, title, type, *description )

  • Info
  • Curl
  • PHP
POST /api/?action=form.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=form.create&tokenID=&companyID=" \   -d "title=&type="
$response = InEvent\Form::create($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "title" => "",
  "type" => ""
]);

Creates a new form at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

titleBODY : form title

typeBODY : type of form

{
    "event-request": "event requisition form",
    "custom": "custom generic form"
}

*descriptionBODY : form description

( tokenID, eventID, title, *description )

  • Info
  • Curl
  • PHP
POST /api/?action=form.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=form.create&tokenID=&eventID=" \   -d "title="
$response = InEvent\Form::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "title" => ""
]);

Creates a new form at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

titleBODY : form title

*descriptionBODY : form description

form.edit

( tokenID, formID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=form.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=form.edit&tokenID=&formID=&key=" \   -d "value="
$response = InEvent\Form::edit($client, [
  "tokenID" => "",
  "formID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of form formID.

tokenIDQUERY : token identifier

formIDQUERY : form identifier

keyQUERY : field name

{
    "title": "form title",
    "description": "form description"
}

valueBODY : field value

{
    "title": "string",
    "description": "string"
}

form.remove

( tokenID, formID )

  • Info
  • Curl
  • PHP
GET /api/?action=form.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=form.remove&tokenID=&formID="
$response = InEvent\Form::remove($client, [
  "tokenID" => "",
  "formID" => ""
]);

Removes form formID.

tokenIDQUERY : token identifier

formIDQUERY : form identifier

form.find

( tokenID, companyID, selection, *complementRegistration, *listing )

  • Info
  • Curl
  • PHP
GET /api/?action=form.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=form.find&tokenID=&companyID=&selection="
$response = InEvent\Form::find($client, [
  "tokenID" => "",
  "companyID" => "",
  "selection" => ""
]);

Gathers all forms created at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

selectionQUERY : filter

{
    "all": "all forms for company",
    "custom": "custom forms for company",
    "event-request": "event requisition forms for company"
}

*complementRegistrationQUERY : forms with or without the flag 'complement registration form'.

*listingQUERY : simplified listing for forms.

( tokenID, eventID, *complementRegistration, *listing )

  • Info
  • Curl
  • PHP
GET /api/?action=form.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=form.find&tokenID=&eventID="
$response = InEvent\Form::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all forms created at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*complementRegistrationQUERY : forms with or without the flag 'complement registration form'.

*listingQUERY : simplified listing for forms.

form.get

( tokenID, formID, *listing )

  • Info
  • Curl
  • PHP
GET /api/?action=form.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=form.get&tokenID=&formID="
$response = InEvent\Form::get($client, [
  "tokenID" => "",
  "formID" => ""
]);

Gathers form formID.

tokenIDQUERY : token identifier

formIDQUERY : form identifier

*listingQUERY : simplified listing for forms.

form.respondRegistration

( *tokenID, eventID, *login, ticketPersonID, ticketToken, feedbackContent, *email, *username, *firstName, *lastName, *password, *role, *company, *image, *private, *guestContent, *activities, *tagIDs )

  • Info
  • Curl
  • PHP
POST /api/?action=form.respondRegistrationHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=form.respondRegistration&eventID=&ticketPersonID=" \   -d "ticketToken=&feedbackContent="
$response = InEvent\Form::respondRegistration($client, [
  "eventID" => "",
  "ticketPersonID" => ""
], [
  "ticketToken" => "",
  "feedbackContent" => ""
]);

Responds form for event eventID registration with ticket invitation ticketToken.

*tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*loginQUERY : should login after register (default 0)

ticketPersonIDQUERY : ticket identifier

ticketTokenBODY : ticket token identifier

feedbackContentBODY : feedback content field

*emailBODY : email field

*usernameBODY : username field

*firstNameBODY : first name field

*lastNameBODY : last name field

*passwordBODY : password field

*roleBODY : role field

*companyBODY : company field

*imageBODY : image field

*privateBODY : private for other people

*guestContentBODY : guest content field

*activitiesBODY : list of activities ids

*tagIDsBODY : list of tag ids

( *tokenID, *login, eventID, feedbackContent, *invite, *email, *username, *firstName, *lastName, *password, *role, *company, *image, *rsvp, *private, *guestContent, *activities, *tagIDs )

  • Info
  • Curl
  • PHP
POST /api/?action=form.respondRegistrationHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=form.respondRegistration&eventID=" \   -d "feedbackContent="
$response = InEvent\Form::respondRegistration($client, [
  "eventID" => ""
], [
  "feedbackContent" => ""
]);

Responds form for event eventID registration.

*tokenIDQUERY : token identifier

*loginQUERY : should login after register (default 0)

eventIDQUERY : event identifier

feedbackContentBODY : feedback content field

*inviteBODY : invite field

*emailBODY : email field

*usernameBODY : username field

*firstNameBODY : first name field

*lastNameBODY : last name field

*passwordBODY : password field

*roleBODY : role field

*companyBODY : company field

*imageBODY : image field

*rsvpBODY : event identifier

*privateBODY : private for other people

*guestContentBODY : guest content field

*activitiesBODY : list of activities ids

*tagIDsBODY : list of tag ids

form.respondCustom

( tokenID, eventID, formID, content, *personID )

  • Info
  • Curl
  • PHP
POST /api/?action=form.respondCustomHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=form.respondCustom&tokenID=&eventID=&formID=" \   -d "content="
$response = InEvent\Form::respondCustom($client, [
  "tokenID" => "",
  "eventID" => "",
  "formID" => ""
], [
  "content" => ""
]);

Answers feedback at event eventID for person personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

formIDQUERY : form identifier

contentBODY : JSON content

[
    {
        "feedbackID": "integer",
        "value": "string or array (if feedback.type = 'multiple')"
    }
]

*personIDQUERY : person identifier

( tokenID, eventID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=form.respondCustomHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=form.respondCustom&tokenID=&eventID=" \   -d "content="
$response = InEvent\Form::respondCustom($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Answers feedback at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : JSON content

[
    {
        "feedbackID": "integer",
        "value": "string or array (if feedback.type = 'multiple')"
    }
]

( eventID, content, invite )

  • Info
  • Curl
  • PHP
POST /api/?action=form.respondCustomHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=form.respondCustom&eventID=&invite=" \   -d "content="
$response = InEvent\Form::respondCustom($client, [
  "eventID" => "",
  "invite" => ""
], [
  "content" => ""
]);

Answers feedback at event eventID for person invite.

eventIDQUERY : event identifier

contentBODY : JSON content

[
    {
        "feedbackID": "integer",
        "value": "string or array (if feedback.type = 'multiple')"
    }
]

inviteQUERY : invite field

( eventID, content, personID, password )

  • Info
  • Curl
  • PHP
POST /api/?action=form.respondCustomHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=form.respondCustom&eventID=&personID=" \   -d "content=&password="
$response = InEvent\Form::respondCustom($client, [
  "eventID" => "",
  "personID" => ""
], [
  "content" => "",
  "password" => ""
]);

Answers feedback at event eventID for person personID with password.

eventIDQUERY : event identifier

contentBODY : JSON content

[
    {
        "feedbackID": "integer",
        "value": "string or array (if feedback.type = 'multiple')"
    }
]

personIDQUERY : person identifier

passwordBODY : person password

form.respondMeeting

( tokenID, eventID, formID, content, *personID )

  • Info
  • Curl
  • PHP
POST /api/?action=form.respondMeetingHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=form.respondMeeting&tokenID=&eventID=&formID=" \   -d "content="
$response = InEvent\Form::respondMeeting($client, [
  "tokenID" => "",
  "eventID" => "",
  "formID" => ""
], [
  "content" => ""
]);

Answers single or several feedbacks at event eventID for person personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

formIDQUERY : form identifier

contentBODY : JSON content

[
    {
        "feedbackID": "integer",
        "value": "string or array (if feedback.type = 'multiple')"
    }
]

*personIDQUERY : person identifier

( tokenID, eventID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=form.respondMeetingHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=form.respondMeeting&tokenID=&eventID=" \   -d "content="
$response = InEvent\Form::respondMeeting($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Answers single or several feedbacks at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : JSON content

[
    {
        "feedbackID": "integer",
        "value": "string or array (if feedback.type = 'multiple')"
    }
]

( eventID, content, invite )

  • Info
  • Curl
  • PHP
POST /api/?action=form.respondMeetingHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=form.respondMeeting&eventID=&invite=" \   -d "content="
$response = InEvent\Form::respondMeeting($client, [
  "eventID" => "",
  "invite" => ""
], [
  "content" => ""
]);

Answers single or several feedbacks at event eventID for person invite.

eventIDQUERY : event identifier

contentBODY : JSON content

[
    {
        "feedbackID": "integer",
        "value": "string or array (if feedback.type = 'multiple')"
    }
]

inviteQUERY : invite field

( eventID, content, personID, password )

  • Info
  • Curl
  • PHP
POST /api/?action=form.respondMeetingHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=form.respondMeeting&eventID=&personID=" \   -d "content=&password="
$response = InEvent\Form::respondMeeting($client, [
  "eventID" => "",
  "personID" => ""
], [
  "content" => "",
  "password" => ""
]);

Answers single or several feedbacks at event eventID for person personID with password.

eventIDQUERY : event identifier

contentBODY : JSON content

[
    {
        "feedbackID": "integer",
        "value": "string or array (if feedback.type = 'multiple')"
    }
]

personIDQUERY : person identifier

passwordBODY : person password

Form lists

Forms can be restricted to people part of a single or several lists.

Models

{
    "count": 1,
    "data": [
        {
            "formID": "330",
            "listID": "1"
        }
    ]
}

Methods

form.list.bind

( tokenID, listID, formID )

  • Info
  • Curl
  • PHP
GET /api/?action=form.list.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=form.list.bind&tokenID=&listID=&formID="
$response = InEvent\Form.list::bind($client, [
  "tokenID" => "",
  "listID" => "",
  "formID" => ""
]);

Requests list listID creation on form formID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

formIDQUERY : form identifier

form.list.dismiss

( tokenID, listID, formID )

  • Info
  • Curl
  • PHP
GET /api/?action=form.list.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=form.list.dismiss&tokenID=&listID=&formID="
$response = InEvent\Form.list::dismiss($client, [
  "tokenID" => "",
  "listID" => "",
  "formID" => ""
]);

Removes list listID from form formID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

formIDQUERY : form identifier

form.list.find

( tokenID, formID )

  • Info
  • Curl
  • PHP
GET /api/?action=form.list.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=form.list.find&tokenID=&formID="
$response = InEvent\Form.list::find($client, [
  "tokenID" => "",
  "formID" => ""
]);

Returns all lists from form formID.

tokenIDQUERY : token identifier

formIDQUERY : form identifier

Gamification

Event organizers may make use of gamification systems to engage their attendees in their mobile app. It is a great way to give away prizes for most engaged attendees at event as well.

Models

{
    "count": 1,
    "data": [
        {
            "gamificationID": "2",
            "eventID": "6508",
            "name": "2nd mission",
            "description": "Send a chat message for someone at the event.",
            "points": "10",
            "date": "1488218414"
        }
    ]
}

Methods

gamification.create

( tokenID, eventID, name, description, points )

  • Info
  • Curl
  • PHP
POST /api/?action=gamification.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=gamification.create&tokenID=&eventID=" \   -d "name=&description=&points="
$response = InEvent\Gamification::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "description" => "",
  "points" => ""
]);

Creates a mission at event eventID with name name, description description and points points.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : mission name

descriptionBODY : mission description

pointsBODY : mission points

gamification.edit

( tokenID, gamificationID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=gamification.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=gamification.edit&tokenID=&gamificationID=&key=" \   -d "value="
$response = InEvent\Gamification::edit($client, [
  "tokenID" => "",
  "gamificationID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of mission gamificationID.

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

keyQUERY : field name

{
    "name": "name",
    "description": "description",
    "points": "points"
}

valueBODY : field value

{
    "name": "string",
    "description": "string",
    "points": "integer"
}

gamification.remove

( tokenID, gamificationID )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=gamification.remove&tokenID=&gamificationID="
$response = InEvent\Gamification::remove($client, [
  "tokenID" => "",
  "gamificationID" => ""
]);

Removes mission gamificationID.

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

gamification.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=gamification.find&tokenID=&eventID="
$response = InEvent\Gamification::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all missions at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

gamification.get

( tokenID, gamificationID )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=gamification.get&tokenID=&gamificationID="
$response = InEvent\Gamification::get($client, [
  "tokenID" => "",
  "gamificationID" => ""
]);

Gathers mission gamificationID.

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

gamification.leaderboard

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.leaderboardHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=gamification.leaderboard&tokenID=&eventID="
$response = InEvent\Gamification::leaderboard($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers leaderboard for all missions at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

Person missions

For each mission at event, attendees can complete them to earn points.

Models

{
    "count": 1,
    "data": [
        {
            "beaconEventID": "1",
            "eventID": "1",
            "beaconID": "2",
            "type": "push",
            "range": "7900",
            "extra": "Hello World"
        }
    ]
}

Methods

gamification.person.bind

( tokenID, gamificationID, name, username )

  • Info
  • Curl
  • PHP
POST /api/?action=gamification.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=gamification.person.bind&tokenID=&gamificationID=" \   -d "name=&username="
$response = InEvent\Gamification.person::bind($client, [
  "tokenID" => "",
  "gamificationID" => ""
], [
  "name" => "",
  "username" => ""
]);

Adds a mission gamificationID for person with name name and user username.

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

nameBODY : person name

usernameBODY : person username

( tokenID, gamificationID )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=gamification.person.bind&tokenID=&gamificationID="
$response = InEvent\Gamification.person::bind($client, [
  "tokenID" => "",
  "gamificationID" => ""
]);

Adds a mission gamificationID for person.

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

gamification.person.operate

( tokenID, gamificationID, key, value, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=gamification.person.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=gamification.person.operate&tokenID=&gamificationID=&key=&personID=" \   -d "value="
$response = InEvent\Gamification.person::operate($client, [
  "tokenID" => "",
  "gamificationID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

Edits value value from field key of mission gamificationID for person personID.

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

keyQUERY : field name

{
    "confirmed": "confirms the mission"
}

valueBODY : field value

{
    "confirmed": "integer"
}

personIDQUERY : person identifier

gamification.person.dismiss

( tokenID, gamificationID )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=gamification.person.dismiss&tokenID=&gamificationID="
$response = InEvent\Gamification.person::dismiss($client, [
  "tokenID" => "",
  "gamificationID" => ""
]);

Removes mission gamificationID from person.

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

gamification.person.find

( tokenID, gamificationID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.person.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=gamification.person.find&tokenID=&gamificationID=&selection="
$response = InEvent\Gamification.person::find($client, [
  "tokenID" => "",
  "gamificationID" => "",
  "selection" => ""
]);

Gathers all people that finished mission gamificationID.

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

selectionQUERY : selection of missions

{
    "all": "default option",
    "confirmed": "only confirmed people"
}

gamification.person.get

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.person.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=gamification.person.get&tokenID=&eventID=&personID="
$response = InEvent\Gamification.person::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Gathers all finished missions for person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

Hotsite

Event / Company hotsite setup. Allows the definition of which sections will be active and its order on the hotsite.

Models

{
    "count": 1,
    "data": [
        {
            "companyID": "",
            "eventID": "1",
            "section": "speakers",
            "position": "2",
            "name": "Some name",
            "text": "Some text or link"
        }
    ]
}

Methods

hotsite.create

( tokenID, companyID, section, position, *name, *text )

  • Info
  • Curl
  • PHP
POST /api/?action=hotsite.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=hotsite.create&tokenID=&companyID=§ion=" \   -d "position="
$response = InEvent\Hotsite::create($client, [
  "tokenID" => "",
  "companyID" => "",
  "section" => ""
], [
  "position" => ""
]);

Adds section section on hotsite at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

sectionQUERY : section name

positionBODY : order among the sections

*nameBODY : section name

*textBODY : section text

( tokenID, eventID, section, position, *name, *text )

  • Info
  • Curl
  • PHP
POST /api/?action=hotsite.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=hotsite.create&tokenID=&eventID=§ion=" \   -d "position="
$response = InEvent\Hotsite::create($client, [
  "tokenID" => "",
  "eventID" => "",
  "section" => ""
], [
  "position" => ""
]);

Adds section section on hotsite at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sectionQUERY : section name

positionBODY : order among the sections

*nameBODY : section name

*textBODY : section text

hotsite.edit

( tokenID, companyID, section, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=hotsite.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=hotsite.edit&tokenID=&companyID=§ion=&key=" \   -d "value="
$response = InEvent\Hotsite::edit($client, [
  "tokenID" => "",
  "companyID" => "",
  "section" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key for hotsite section at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

sectionQUERY : section identifier

keyQUERY : element name

{
    "name": "section name",
    "text": "section extra",
    "menu": "should show on menu",
    "position": "section position"
}

valueBODY : desired action

{
    "name": "string",
    "text": "string",
    "menu": "boolean",
    "position": "integer"
}

( tokenID, eventID, section, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=hotsite.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=hotsite.edit&tokenID=&eventID=§ion=&key=" \   -d "value="
$response = InEvent\Hotsite::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "section" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key for hotsite section at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sectionQUERY : section identifier

keyQUERY : element name

{
    "name": "section name",
    "text": "section extra",
    "menu": "should show on menu",
    "position": "section position"
}

valueBODY : desired action

{
    "name": "string",
    "text": "string",
    "menu": "boolean",
    "position": "integer"
}

( tokenID, companyID, section, content )

  • Info
  • Curl
  • PHP
POST /api/?action=hotsite.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=hotsite.edit&tokenID=&companyID=§ion=" \   -d "content="
$response = InEvent\Hotsite::edit($client, [
  "tokenID" => "",
  "companyID" => "",
  "section" => ""
], [
  "content" => ""
]);

Edits values content for hotsite section at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

sectionQUERY : section identifier

contentBODY : array of key values for editing

{
    "key": "string",
    "value": "string"
}

( tokenID, eventID, section, content )

  • Info
  • Curl
  • PHP
POST /api/?action=hotsite.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=hotsite.edit&tokenID=&eventID=§ion=" \   -d "content="
$response = InEvent\Hotsite::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "section" => ""
], [
  "content" => ""
]);

Edits values content for hotsite section at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sectionQUERY : section identifier

contentBODY : array of key values for editing

{
    "key": "string",
    "value": "string"
}

hotsite.remove

( tokenID, companyID, section )

  • Info
  • Curl
  • PHP
GET /api/?action=hotsite.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=hotsite.remove&tokenID=&companyID=§ion="
$response = InEvent\Hotsite::remove($client, [
  "tokenID" => "",
  "companyID" => "",
  "section" => ""
]);

Removes section section from company companyID hotsite.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

sectionQUERY : section name

( tokenID, eventID, section )

  • Info
  • Curl
  • PHP
GET /api/?action=hotsite.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=hotsite.remove&tokenID=&eventID=§ion="
$response = InEvent\Hotsite::remove($client, [
  "tokenID" => "",
  "eventID" => "",
  "section" => ""
]);

Removes section section from event eventID hotsite.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sectionQUERY : section name

hotsite.find

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=hotsite.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=hotsite.find&tokenID=&companyID="
$response = InEvent\Hotsite::find($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns all sections linked to company companyID hotsite.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=hotsite.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=hotsite.find&tokenID=&eventID="
$response = InEvent\Hotsite::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all sections linked to event eventID hotsite.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

hotsite.get

( tokenID, companyID, section )

  • Info
  • Curl
  • PHP
GET /api/?action=hotsite.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=hotsite.get&tokenID=&companyID=§ion="
$response = InEvent\Hotsite::get($client, [
  "tokenID" => "",
  "companyID" => "",
  "section" => ""
]);

Returns section section linked to company companyID hotsite.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

sectionQUERY : section name

( tokenID, eventID, section )

  • Info
  • Curl
  • PHP
GET /api/?action=hotsite.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=hotsite.get&tokenID=&eventID=§ion="
$response = InEvent\Hotsite::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "section" => ""
]);

Returns section section linked to event eventID hotsite.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sectionQUERY : section name

hotsite.getConfig

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=hotsite.getConfigHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=hotsite.getConfig&tokenID=&companyID="
$response = InEvent\Hotsite::getConfig($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns current configurations from company companyID hotsite.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=hotsite.getConfigHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=hotsite.getConfig&tokenID=&eventID="
$response = InEvent\Hotsite::getConfig($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns current configurations from event eventID hotsite.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

hotsite.setConfig

( tokenID, companyID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=hotsite.setConfigHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=hotsite.setConfig&tokenID=&companyID=&key=" \   -d "value="
$response = InEvent\Hotsite::setConfig($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
], [
  "value" => ""
]);

Configures hotsite elements from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

keyQUERY : field name

{
    "template": "template name",
    "saveTheDate": "activates Save the Date",
    "registrationLink": "registration link",
    "sponsorCategory": "activates sponsor divided by categories",
    "countdown": "activates countdown",
    "newsletterListId": "newsletter list identifier",
    "backgroundColor": "background color",
    "navigationBarBackgroundColor": "bar color",
    "mainColor": "main color",
    "registration": "activates registration link"
}

valueBODY : field value

{
    "template": "string",
    "saveTheDate": "boolean",
    "registrationLink": "string",
    "sponsorCategory": "boolean",
    "countdown": "boolean",
    "newsletterListId": "integer",
    "backgroundColor": "string",
    "navigationBarBackgroundColor": "string",
    "mainColor": "string",
    "registration": "boolean"
}

( tokenID, eventID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=hotsite.setConfigHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=hotsite.setConfig&tokenID=&eventID=&key=" \   -d "value="
$response = InEvent\Hotsite::setConfig($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

Configures hotsite elements from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : field name

{
    "template": "template name",
    "saveTheDate": "activates Save the Date",
    "registrationLink": "registration link",
    "sponsorCategory": "activates sponsor divided by categories",
    "countdown": "activates countdown",
    "newsletterListId": "newsletter list identifier",
    "backgroundColor": "background color",
    "navigationBarBackgroundColor": "bar color",
    "mainColor": "main color",
    "registration": "activates registration link"
}

valueBODY : field value

{
    "template": "string",
    "saveTheDate": "boolean",
    "registrationLink": "string",
    "sponsorCategory": "boolean",
    "countdown": "boolean",
    "newsletterListId": "integer",
    "backgroundColor": "string",
    "navigationBarBackgroundColor": "string",
    "mainColor": "string",
    "registration": "boolean"
}

Image library

While creating an event, it may be useful to upload all images necessary to fill your speakers and sponsors pages. This is a library that you can use any image in several resources from your event.

Models

{
    "count": 1,
    "data": [
        {
            "imageID": "1",
            "eventID": "1",
            "name": "picture-1.png",
            "url": "https:\/\/....\/images\/picture.png"
        }
    ]
}

Methods

image.create

( tokenID, eventID, name, url )

  • Info
  • Curl
  • PHP
POST /api/?action=image.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=image.create&tokenID=&eventID=" \   -d "name=&url="
$response = InEvent\Image::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "url" => ""
]);

Adds an image to event eventID library.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : image name

urlBODY : image url

image.edit

( tokenID, imageID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=image.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=image.edit&tokenID=&imageID=&key=" \   -d "value="
$response = InEvent\Image::edit($client, [
  "tokenID" => "",
  "imageID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of image imageID.

tokenIDQUERY : token identifier

imageIDQUERY : image identifier

keyQUERY : field name

{
    "name": "image name",
    "url": "image url"
}

valueBODY : field value

{
    "name": "string",
    "url": "string"
}

image.remove

( tokenID, imageID )

  • Info
  • Curl
  • PHP
GET /api/?action=image.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=image.remove&tokenID=&imageID="
$response = InEvent\Image::remove($client, [
  "tokenID" => "",
  "imageID" => ""
]);

Removes image imageID.

tokenIDQUERY : token identifier

imageIDQUERY : image identifier

image.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=image.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=image.find&tokenID=&eventID="
$response = InEvent\Image::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all images at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

image.get

( tokenID, imageID )

  • Info
  • Curl
  • PHP
GET /api/?action=image.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=image.get&tokenID=&imageID="
$response = InEvent\Image::get($client, [
  "tokenID" => "",
  "imageID" => ""
]);

Gathers image imageID.

tokenIDQUERY : token identifier

imageIDQUERY : image identifier

Invoice

Invoice details for a purchase.

Models

{
    "count": 1,
    "data": [
        {
            "companyID": "1",
            "eventID": "1",
            "personID": "",
            "paymentID": "",
            "companyName": "",
            "companyTaxId": "",
            "addressLine1": "",
            "addressLine2": "",
            "status": "",
            "createdAt": "",
            "dueAt": ""
        }
    ]
}

Methods

invoice.create

( tokenID, eventID, *personID, paymentID, companyName, companyTaxId, addressLine1, addressLine2 )

  • Info
  • Curl
  • PHP
POST /api/?action=invoice.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=invoice.create&tokenID=&eventID=&paymentID=" \   -d "companyName=&companyTaxId=&addressLine1=&addressLine2="
$response = InEvent\Invoice::create($client, [
  "tokenID" => "",
  "eventID" => "",
  "paymentID" => ""
], [
  "companyName" => "",
  "companyTaxId" => "",
  "addressLine1" => "",
  "addressLine2" => ""
]);

Creates a new invoice for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*personIDQUERY : person identifier

paymentIDQUERY : payment identifier

companyNameBODY : company name

companyTaxIdBODY : company tax id

addressLine1BODY : address line 1

addressLine2BODY : address line 2

invoice.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=invoice.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=invoice.find&tokenID=&eventID="
$response = InEvent\Invoice::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Find all invoices for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

invoice.get

( tokenID, invoiceID )

  • Info
  • Curl
  • PHP
GET /api/?action=invoice.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=invoice.get&tokenID=&invoiceID="
$response = InEvent\Invoice::get($client, [
  "tokenID" => "",
  "invoiceID" => ""
]);

Gets invoice invoiceID.

tokenIDQUERY : token identifier

invoiceIDQUERY : invoice identifier

( encryptedInvoiceID )

  • Info
  • Curl
  • PHP
GET /api/?action=invoice.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=invoice.get&encryptedInvoiceID="
$response = InEvent\Invoice::get($client, [
  "encryptedInvoiceID" => ""
]);

Gets invoice using encrypted key encryptedInvoiceID.

encryptedInvoiceIDQUERY : encrypted invoice identifier

Landing

It is possible to create several distinct landings for a given event, with complete custom HTML and hosted on our platform. You may set a specific domain for each landing, and these landings may have several pages as well.

Models

{
    "count": 1,
    "data": [
        {
            "companyID": "1",
            "eventID": "1",
            "landingID": "1",
            "name": "InEvent",
            "cname": "inevent.com"
        }
    ]
}

Methods

landing.create

( tokenID, companyID, name, cname )

  • Info
  • Curl
  • PHP
POST /api/?action=landing.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=landing.create&tokenID=&companyID=" \   -d "name=&cname="
$response = InEvent\Landing::create($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "name" => "",
  "cname" => ""
]);

Creates a landing at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

nameBODY : landing title

cnameBODY : landing domain

( tokenID, eventID, name, cname )

  • Info
  • Curl
  • PHP
POST /api/?action=landing.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=landing.create&tokenID=&eventID=" \   -d "name=&cname="
$response = InEvent\Landing::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "cname" => ""
]);

Creates a landing at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : landing title

cnameBODY : landing domain

landing.edit

( tokenID, landingID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=landing.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=landing.edit&tokenID=&landingID=&key=" \   -d "value="
$response = InEvent\Landing::edit($client, [
  "tokenID" => "",
  "landingID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of landing landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

keyQUERY : field key

{
    "name": "landing title",
    "cname": "landing domain"
}

valueBODY : field value

{
    "name": "string",
    "cname": "string"
}

landing.remove

( tokenID, landingID )

  • Info
  • Curl
  • PHP
GET /api/?action=landing.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=landing.remove&tokenID=&landingID="
$response = InEvent\Landing::remove($client, [
  "tokenID" => "",
  "landingID" => ""
]);

Removes landing landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

landing.find

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=landing.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=landing.find&tokenID=&companyID="
$response = InEvent\Landing::find($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Gathers all landings at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=landing.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=landing.find&tokenID=&eventID="
$response = InEvent\Landing::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all landings at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

landing.get

( tokenID, landingID )

  • Info
  • Curl
  • PHP
GET /api/?action=landing.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=landing.get&tokenID=&landingID="
$response = InEvent\Landing::get($client, [
  "tokenID" => "",
  "landingID" => ""
]);

Gathers landing landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

landing.put

( tokenID, landingID, file, url )

  • Info
  • Curl
  • PHP
POST /api/?action=landing.putHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=landing.put&tokenID=&landingID=" \   -d "file=&url="
$response = InEvent\Landing::put($client, [
  "tokenID" => "",
  "landingID" => ""
], [
  "file" => "",
  "url" => ""
]);

Creates or edits a file in landing landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

fileBODY : file name

urlBODY : file url

landing.delete

( tokenID, landingID, file )

  • Info
  • Curl
  • PHP
POST /api/?action=landing.deleteHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=landing.delete&tokenID=&landingID=" \   -d "file="
$response = InEvent\Landing::delete($client, [
  "tokenID" => "",
  "landingID" => ""
], [
  "file" => ""
]);

Deletes a file in landing landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

fileBODY : file name

landing.copy

( tokenID, landingID, sourceLandingID )

  • Info
  • Curl
  • PHP
GET /api/?action=landing.copyHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=landing.copy&tokenID=&landingID=&sourceLandingID="
$response = InEvent\Landing::copy($client, [
  "tokenID" => "",
  "landingID" => "",
  "sourceLandingID" => ""
]);

Copy all files from sourceLandingID to landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

sourceLandingIDQUERY : landing source identifier

Landing pages

In a specific landing, it is possible to create several pages with distinct paths.

Models

{
    "count": 1,
    "data": [
        {
            "landingPageID": "1",
            "landingID": "1",
            "path": "\/faq\/",
            "file": "faq.html"
        }
    ]
}

Methods

landing.page.bind

( tokenID, landingID, path, file )

  • Info
  • Curl
  • PHP
POST /api/?action=landing.page.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=landing.page.bind&tokenID=&landingID=" \   -d "path=&file="
$response = InEvent\Landing.page::bind($client, [
  "tokenID" => "",
  "landingID" => ""
], [
  "path" => "",
  "file" => ""
]);

Creates a page in landing landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

pathBODY : file url

fileBODY : file name

landing.page.operate

( tokenID, landingPageID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=landing.page.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=landing.page.operate&tokenID=&landingPageID=&key=" \   -d "value="
$response = InEvent\Landing.page::operate($client, [
  "tokenID" => "",
  "landingPageID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key in landing page landingPageID.

tokenIDQUERY : token identifier

landingPageIDQUERY : landing page identifier

keyQUERY : field name

{
    "path": "file url",
    "file": "file name"
}

valueBODY : field value

{
    "path": "string",
    "file": "string"
}

landing.page.dismiss

( tokenID, landingPageID )

  • Info
  • Curl
  • PHP
GET /api/?action=landing.page.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=landing.page.dismiss&tokenID=&landingPageID="
$response = InEvent\Landing.page::dismiss($client, [
  "tokenID" => "",
  "landingPageID" => ""
]);

Removes landing page landingPageID.

tokenIDQUERY : token identifier

landingPageIDQUERY : landing page identifier

landing.page.find

( tokenID, landingID )

  • Info
  • Curl
  • PHP
GET /api/?action=landing.page.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=landing.page.find&tokenID=&landingID="
$response = InEvent\Landing.page::find($client, [
  "tokenID" => "",
  "landingID" => ""
]);

Gathers all pages from landing landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

landing.page.get

( tokenID, landingPageID )

  • Info
  • Curl
  • PHP
GET /api/?action=landing.page.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=landing.page.get&tokenID=&landingPageID="
$response = InEvent\Landing.page::get($client, [
  "tokenID" => "",
  "landingPageID" => ""
]);

Gathers landing page landingPageID.

tokenIDQUERY : token identifier

landingPageIDQUERY : landing page identifier

Leads

Endpoint that gathers all people of the event (attendees, invites, waitlists and lists)

Models

{
    "count": 1,
    "data": [
        {
            "id": "1",
            "local": "attendees",
            "name": "InEvent Person",
            "username": "ineventperson",
            "email": "inevent@inevent.com",
            "atevent": "yes"
        }
    ]
}

Methods

leads.find

( tokenID, eventID, *selection, *query, *queryKey, *sort, *sortDirection, *filterStatus, *filterList, *filterTicket, *paginated, *filterCount )

  • Info
  • Curl
  • PHP
GET /api/?action=leads.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=leads.find&tokenID=&eventID="
$response = InEvent\Leads::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Find all leads at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*selectionQUERY : selection for search

*queryQUERY : query for search

*queryKeyQUERY : query key for search

{
    "name": "name",
    "username": "username",
    "email": "email",
    "role": "position",
    "company": "company"
}

*sortQUERY : sort for search

{
    "status": "enrolled",
    "name": "name",
    "email": "email",
    "username": "username",
    "invited": "invited people",
    "onList": "people on list",
    "atEvent": "enrolled attendees",
    "dateInsert": "first known date"
}

*sortDirectionQUERY : sort direction for search

{
    "ASC": "Order by ascending",
    "DESC": "Order by descending"
}

*filterStatusQUERY : filter for status of Leads

{
    "allLeads": "everyone",
    "attendee": "enrolled attendees",
    "invite": "invited people",
    "listMember": "people on list",
    "waitlist": "people on pending list"
}

*filterListQUERY : filter for lists

*filterTicketQUERY : filter for tickets

*paginatedQUERY : paginated result, yes or no

*filterCountQUERY : return count for filters

leads.getFilters

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=leads.getFiltersHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=leads.getFilters&tokenID=&eventID="
$response = InEvent\Leads::getFilters($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Get filter for leads at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

leads.remove

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=leads.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=leads.remove&tokenID=&eventID=&personID="
$response = InEvent\Leads::remove($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Remove a lead personID from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=leads.removeHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=leads.remove&tokenID=&eventID=" \   -d "content="
$response = InEvent\Leads::remove($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Mass remove people from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : content with person or persons identifier

License

Validate the current available licenses on the platform

Models

{
    "count": 1,
    "data": [
        {
            "licenseID": "1",
            "course": "InEvent Certified",
            "score": "99",
            "date": "1538073319"
        }
    ]
}

Methods

license.create

( tokenID, username, course, location )

  • Info
  • Curl
  • PHP
POST /api/?action=license.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=license.create&tokenID=" \   -d "username=&course=&location="
$response = InEvent\License::create($client, [
  "tokenID" => ""
], [
  "username" => "",
  "course" => "",
  "location" => ""
]);

Creates license for person username.

tokenIDQUERY : token identifier

usernameBODY : person username

courseBODY : achievement title

locationBODY : global location

license.edit

( tokenID, number, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=license.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=license.edit&tokenID=&number=&key=" \   -d "value="
$response = InEvent\License::edit($client, [
  "tokenID" => "",
  "number" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of license number.

tokenIDQUERY : token identifier

numberQUERY : license number

keyQUERY : field name

valueBODY : field value

license.remove

( tokenID, number )

  • Info
  • Curl
  • PHP
GET /api/?action=license.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=license.remove&tokenID=&number="
$response = InEvent\License::remove($client, [
  "tokenID" => "",
  "number" => ""
]);

Removes license number.

tokenIDQUERY : token identifier

numberQUERY : license number

license.find

( query )

  • Info
  • Curl
  • PHP
GET /api/?action=license.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=license.find&query="
$response = InEvent\License::find($client, [
  "query" => ""
]);

Returns licenses for query query.

queryQUERY : search terms

license.get

( number )

  • Info
  • Curl
  • PHP
GET /api/?action=license.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=license.get&number="
$response = InEvent\License::get($client, [
  "number" => ""
]);

Returns license number.

numberQUERY : unique license

license.request

( number, leadEmail )

  • Info
  • Curl
  • PHP
POST /api/?action=license.requestHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=license.request&number=" \   -d "leadEmail="
$response = InEvent\License::request($client, [
  "number" => ""
], [
  "leadEmail" => ""
]);

Requests more information on license number.

numberQUERY : unique license

leadEmailBODY : lead email

LinkedIn

The content below pertains to operations on the professional LinkedIn network. It is essential that relational data be obtained on the various interests of a person so that the possibilities present in an event can be correlated. The required permissions that must be requested are r_basicprofile, r_fullprofile, r_network and r_emailaddress.

Methods

linkedin.signIn

( linkedInToken )

  • Info
  • Curl
  • PHP
GET /api/?action=linkedin.signInHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=linkedin.signIn&linkedInToken="
$response = InEvent\Linkedin::signIn($client, [
  "linkedInToken" => ""
]);

Creates a session with LinkedIn using OAuth v2.0.

linkedInTokenQUERY : LinkedIn token provided by LinkedIn platform

Segmentation lists

Segmentation lists are great way to distinct specific group of leads for your event and even for your company. You can create a segmentation list in your company and use in all of your events every time you want.

Models

{
    "count": 1,
    "data": [
        {
            "listID": "4",
            "eventID": "1",
            "name": "Marketing",
            "color": "#ff0000"
        }
    ]
}

Methods

list.create

( tokenID, eventID, name, color )

  • Info
  • Curl
  • PHP
POST /api/?action=list.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.create&tokenID=&eventID=" \   -d "name=&color="
$response = InEvent\List::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "color" => ""
]);

Creates a segmentation list with name name and color color at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : name of the list

colorBODY : list color

( tokenID, companyID, name, color )

  • Info
  • Curl
  • PHP
POST /api/?action=list.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.create&tokenID=&companyID=" \   -d "name=&color="
$response = InEvent\List::create($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "name" => "",
  "color" => ""
]);

Creates a segmentation list with name name and color color at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

nameBODY : list name

colorBODY : list color

list.edit

( tokenID, listID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=list.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.edit&tokenID=&listID=&key=" \   -d "value="
$response = InEvent\List::edit($client, [
  "tokenID" => "",
  "listID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of segmentation list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

keyQUERY : field name

{
    "name": "list name",
    "color": "list color"
}

valueBODY : field value

{
    "name": "string",
    "color": "string"
}

list.remove

( tokenID, listID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.remove&tokenID=&listID="
$response = InEvent\List::remove($client, [
  "tokenID" => "",
  "listID" => ""
]);

Removes segmentation list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

list.find

( tokenID, eventID, *selection )

  • Info
  • Curl
  • PHP
GET /api/?action=list.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.find&tokenID=&eventID="
$response = InEvent\List::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all segmentation lists at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*selectionQUERY : specific selection

{
    "all": "all lists",
    "public": "public lists",
    "minimal": "lists with reduced payload (all lists)"
}

( tokenID, companyID, *selection )

  • Info
  • Curl
  • PHP
GET /api/?action=list.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.find&tokenID=&companyID="
$response = InEvent\List::find($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Gathers all segmentation lists at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

*selectionQUERY : specific selection

{
    "all": "all lists",
    "public": "public lists",
    "minimal": "lists with reduced payload (all lists)"
}

list.get

( tokenID, listID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.get&tokenID=&listID="
$response = InEvent\List::get($client, [
  "tokenID" => "",
  "listID" => ""
]);

Gathers segmentation list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

list.copy

( tokenID, eventID, listID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.copyHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.copy&tokenID=&eventID=&listID="
$response = InEvent\List::copy($client, [
  "tokenID" => "",
  "eventID" => "",
  "listID" => ""
]);

Imports a segmentation list listID from your company to event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

listIDQUERY : list identifier

list.import

( tokenID, eventID, sourceID, targetID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.importHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.import&tokenID=&eventID=&sourceID=&targetID="
$response = InEvent\List::import($client, [
  "tokenID" => "",
  "eventID" => "",
  "sourceID" => "",
  "targetID" => ""
]);

Imports data to list targetID from a segmentation list sourceID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sourceIDQUERY : list identifier

targetIDQUERY : list identifier

Email for segmentation lists

Manage emails for specific segmentation lists, allowing you to send emails for specific groups of people.

Models

{
    "count": 1,
    "data": [
        {
            "listEmailID": "16",
            "listID": "16",
            "eventID": "4",
            "subject": "Hello World",
            "html": "

Hello World some text might go here<\/p>", "sent": "0", "date": "124151252" } ] }

Methods

list.email.create

( tokenID, listID, subject, html )

  • Info
  • Curl
  • PHP
POST /api/?action=list.email.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.email.create&tokenID=&listID=" \   -d "subject=&html="
$response = InEvent\List.email::create($client, [
  "tokenID" => "",
  "listID" => ""
], [
  "subject" => "",
  "html" => ""
]);

Creates an email at list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

subjectBODY : email subject

htmlBODY : email contents

( tokenID, eventID, subject, html, selection )

  • Info
  • Curl
  • PHP
POST /api/?action=list.email.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.email.create&tokenID=&eventID=" \   -d "subject=&html=&selection="
$response = InEvent\List.email::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "subject" => "",
  "html" => "",
  "selection" => ""
]);

Creates an email at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

subjectBODY : email subject

htmlBODY : email contents

selectionBODY : specific selection

{
    "all-attendees": "all attendees",
    "all-invited": "all invitees"
}

( tokenID, eventID, source )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.createHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.email.create&tokenID=&eventID=&source="
$response = InEvent\List.email::create($client, [
  "tokenID" => "",
  "eventID" => "",
  "source" => ""
]);

Creates an automatic email at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sourceQUERY : email source

list.email.edit

( tokenID, listEmailID, key, *value )

  • Info
  • Curl
  • PHP
POST /api/?action=list.email.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.email.edit&tokenID=&listEmailID=&key=" \   -d ""
$response = InEvent\List.email::edit($client, [
  "tokenID" => "",
  "listEmailID" => "",
  "key" => ""
], [

]);

Edits value value from field key at email from list listEmailID.

tokenIDQUERY : token identifier

listEmailIDQUERY : list identifier

keyQUERY : field name

{
    "subject": "email subject",
    "html": "email contents"
}

*valueBODY : field value

{
    "subject": "string",
    "html": "string"
}

list.email.remove

( tokenID, listEmailID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.email.remove&tokenID=&listEmailID="
$response = InEvent\List.email::remove($client, [
  "tokenID" => "",
  "listEmailID" => ""
]);

Removes email listEmailID.

tokenIDQUERY : token identifier

listEmailIDQUERY : list email identifier

list.email.find

( tokenID, listID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.email.find&tokenID=&listID="
$response = InEvent\List.email::find($client, [
  "tokenID" => "",
  "listID" => ""
]);

Gathers all emails at list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

( tokenID, eventID, selection, *order, *withAnalytics, *paginated )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.email.find&tokenID=&eventID=&selection="
$response = InEvent\List.email::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Gathers all emails at event eventID without a list linked.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : specific selection

{
    "all-attendees": "all attendees",
    "all-invited": "all invitees"
}

*orderQUERY : the order of the list

*withAnalyticsQUERY : should return with analytics

*paginatedQUERY : should be paginated

list.email.get

( tokenID, listEmailID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.email.get&tokenID=&listEmailID="
$response = InEvent\List.email::get($client, [
  "tokenID" => "",
  "listEmailID" => ""
]);

Returns email listEmailID.

tokenIDQUERY : token identifier

listEmailIDQUERY : list email identifier

list.email.send

( tokenID, listEmailID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.sendHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.email.send&tokenID=&listEmailID="
$response = InEvent\List.email::send($client, [
  "tokenID" => "",
  "listEmailID" => ""
]);

Sends email listEmailID.

tokenIDQUERY : token identifier

listEmailIDQUERY : list email identifier

list.email.copy

( tokenID, listEmailID, *subject, *listID, *selection )

  • Info
  • Curl
  • PHP
POST /api/?action=list.email.copyHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.email.copy&tokenID=&listEmailID=" \   -d ""
$response = InEvent\List.email::copy($client, [
  "tokenID" => "",
  "listEmailID" => ""
], [

]);

Copies email listEmailID for a new draft.

tokenIDQUERY : token identifier

listEmailIDQUERY : list email identifier

*subjectBODY : list email subject

*listIDQUERY : list identifier

*selectionQUERY : specific selection

list.email.preview

( tokenID, listEmailID, *personID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.previewHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.email.preview&tokenID=&listEmailID="
$response = InEvent\List.email::preview($client, [
  "tokenID" => "",
  "listEmailID" => ""
]);

Sends a preview email listEmailID for yourself.

tokenIDQUERY : token identifier

listEmailIDQUERY : list email identifier

*personIDQUERY : person whom should receive the email

list.email.stats

( tokenID, listEmailID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.statsHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.email.stats&tokenID=&listEmailID="
$response = InEvent\List.email::stats($client, [
  "tokenID" => "",
  "listEmailID" => ""
]);

Gathers all email statistics at email listEmailID.

tokenIDQUERY : token identifier

listEmailIDQUERY : list email identifier

People at segmentation lists

Adds people to a segmentation list so you can manage to send emails, sms and use them as you wish.

Models

{
    "count": 1,
    "data": [
        {
            "listPersonID": "16",
            "listID": "16",
            "personID": "4",
            "date": "124151252"
        }
    ]
}

Methods

list.person.bind

( tokenID, listID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.person.bind&tokenID=&listID=&personID="
$response = InEvent\List.person::bind($client, [
  "tokenID" => "",
  "listID" => "",
  "personID" => ""
]);

Adds person personID in list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

personIDQUERY : person identifier

( tokenID, listID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=list.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.person.bind&tokenID=&listID=" \   -d "content="
$response = InEvent\List.person::bind($client, [
  "tokenID" => "",
  "listID" => ""
], [
  "content" => ""
]);

Adds people content in list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

contentBODY : people identifiers

( tokenID, listID, name, username )

  • Info
  • Curl
  • PHP
POST /api/?action=list.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.person.bind&tokenID=&listID=" \   -d "name=&username="
$response = InEvent\List.person::bind($client, [
  "tokenID" => "",
  "listID" => ""
], [
  "name" => "",
  "username" => ""
]);

Adds person with name name and username username in list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

nameBODY : person name

usernameBODY : person username or email

( listID, *name, email )

  • Info
  • Curl
  • PHP
POST /api/?action=list.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.person.bind&listID=" \   -d "email="
$response = InEvent\List.person::bind($client, [
  "listID" => ""
], [
  "email" => ""
]);

Adds person email in list listID.

listIDQUERY : list identifier

*nameBODY : person name

emailBODY : person username or email

( tokenID, listID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=list.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.person.bind&tokenID=&listID=" \   -d "path="
$response = InEvent\List.person::bind($client, [
  "tokenID" => "",
  "listID" => ""
], [
  "path" => ""
]);

Adds people as excel sheet path in list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

pathBODY : people excel sheet url

list.person.operate

( tokenID, eventID, key, value, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=list.person.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.person.operate&tokenID=&eventID=&key=&personID=" \   -d "value="
$response = InEvent\List.person::operate($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

Edits value value from field key for person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : key to edit

{
    "name": "full name",
    "firstName": "first name",
    "lastName": "last name",
    "email": "email",
    "assistantEmail": "assistant email"
}

valueBODY : key value

{
    "name": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "assistantEmail": "string"
}

personIDQUERY : person identifier

list.person.dismiss

( tokenID, listID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.person.dismiss&tokenID=&listID=&personID="
$response = InEvent\List.person::dismiss($client, [
  "tokenID" => "",
  "listID" => "",
  "personID" => ""
]);

Removes person personID from list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

personIDQUERY : person identifier

( tokenID, listID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=list.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.person.dismiss&tokenID=&listID=" \   -d "content="
$response = InEvent\List.person::dismiss($client, [
  "tokenID" => "",
  "listID" => ""
], [
  "content" => ""
]);

Removes people content from list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

contentBODY : people identifiers

list.person.find

( tokenID, listID, *query, *sort, *order )

  • Info
  • Curl
  • PHP
GET /api/?action=list.person.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.person.find&tokenID=&listID="
$response = InEvent\List.person::find($client, [
  "tokenID" => "",
  "listID" => ""
]);

Gathers all people in list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

*queryQUERY : search text

*sortQUERY : sort query

{
    "id": "unique identifier",
    "firstName": "first name",
    "lastName": "last name",
    "email": "email",
    "username": "username",
    "assistantEmail": "assistant email",
    "atEvent": "enrolled on event list"
}

*orderQUERY : order query

{
    "ASC": "Order by ascending",
    "DESC": "Order by descending"
}

list.person.get

( tokenID, *listID, eventID, personID, *last )

  • Info
  • Curl
  • PHP
GET /api/?action=list.person.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.person.get&tokenID=&eventID=&personID="
$response = InEvent\List.person::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Get people in list listID.

tokenIDQUERY : token identifier

*listIDQUERY : list identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

*lastQUERY : get only last registration

list.person.dismissAll

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.person.dismissAllHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.person.dismissAll&tokenID=&eventID=&personID="
$response = InEvent\List.person::dismissAll($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Removes person personID from all lists.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

SMS for segmentation lists

Manage sms for specific segmentation lists, allowing you to send sms for specific groups of people.

Models

{
    "count": 1,
    "data": [
        {
            "listPushID": "16",
            "listID": "16",
            "eventID": "4",
            "text": "Hello World",
            "sent": "0",
            "date": "124151252"
        }
    ]
}

Methods

list.sms.create

( tokenID, *listID, *selection, text )

  • Info
  • Curl
  • PHP
POST /api/?action=list.sms.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.sms.create&tokenID=" \   -d "text="
$response = InEvent\List.sms::create($client, [
  "tokenID" => ""
], [
  "text" => ""
]);

Creates a new sms in list listID.

tokenIDQUERY : token identifier

*listIDQUERY : list identifier

*selectionQUERY : specific selection

textBODY : sms contents

list.sms.edit

( tokenID, listSmsID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=list.sms.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=list.sms.edit&tokenID=&listSmsID=&key=" \   -d "value="
$response = InEvent\List.sms::edit($client, [
  "tokenID" => "",
  "listSmsID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key from sms at list listSmsID.

tokenIDQUERY : token identifier

listSmsIDQUERY : sms at list identifier

keyQUERY : field name

{
    "text": "sms contents"
}

valueBODY : field value

{
    "text": "string"
}

list.sms.remove

( tokenID, listSmsID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.sms.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.sms.remove&tokenID=&listSmsID="
$response = InEvent\List.sms::remove($client, [
  "tokenID" => "",
  "listSmsID" => ""
]);

Removes sms at list listSmsID.

tokenIDQUERY : token identifier

listSmsIDQUERY : sms at list identifier

list.sms.find

( tokenID, listID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.sms.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.sms.find&tokenID=&listID="
$response = InEvent\List.sms::find($client, [
  "tokenID" => "",
  "listID" => ""
]);

Gathers all sms at list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

( tokenID, eventID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=list.sms.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.sms.find&tokenID=&eventID=&selection="
$response = InEvent\List.sms::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Gathers all sms at event eventID without a list linked.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : specific selection

{
    "all-attendees": "all attendees",
    "all-invited": "all invitees"
}

list.sms.preview

( tokenID, listSmsID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.sms.previewHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.sms.preview&tokenID=&listSmsID="
$response = InEvent\List.sms::preview($client, [
  "tokenID" => "",
  "listSmsID" => ""
]);

Sends a preview for sms at listlistSmsID.

tokenIDQUERY : token identifier

listSmsIDQUERY : sms at list identifier

list.sms.send

( tokenID, listSmsID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.sms.sendHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=list.sms.send&tokenID=&listSmsID="
$response = InEvent\List.sms::send($client, [
  "tokenID" => "",
  "listSmsID" => ""
]);

Sends sms at list listSmsID.

tokenIDQUERY : token identifier

listSmsIDQUERY : sms at list identifier

Literature

On our landing page we provide exclusive and qualified content for our visitors.

Models

{
    "count": 1,
    "data": [
        {
            "literatureID": "4",
            "title": "1",
            "picture": "1242",
            "url": "4242",
            "date": "Test title",
            "position": "Test content"
        }
    ]
}

Methods

literature.create

( tokenID, url, category )

  • Info
  • Curl
  • PHP
POST /api/?action=literature.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=literature.create&tokenID=" \   -d "url=&category="
$response = InEvent\Literature::create($client, [
  "tokenID" => ""
], [
  "url" => "",
  "category" => ""
]);

Creates a literature with external url url.

tokenIDQUERY : token identifier

urlBODY : external url

categoryBODY : literature category

{
    "ebook": "E-Book",
    "article": "Article",
    "video": "Video"
}

literature.remove

( tokenID, literatureID )

  • Info
  • Curl
  • PHP
GET /api/?action=literature.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=literature.remove&tokenID=&literatureID="
$response = InEvent\Literature::remove($client, [
  "tokenID" => "",
  "literatureID" => ""
]);

Removes literature literatureID.

tokenIDQUERY : token identifier

literatureIDQUERY : literature identifier

literature.find

( )

  • Info
  • Curl
  • PHP
GET /api/?action=literature.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=literature.find"
$response = InEvent\Literature::find($client, [

]);

Gathers all literatures.

Live

Models

{
    "count": 1,
    "data": [
        {
            "*": "mixed"
        }
    ]
}

Methods

live.createRoom

( tokenID, eventID, *personID )

  • Info
  • Curl
  • PHP
GET /api/?action=live.createRoomHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.createRoom&tokenID=&eventID="
$response = InEvent\Live::createRoom($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Create room for live stream.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*personIDQUERY : person identifier

live.authRoom

( tokenID, eventID, roomId )

  • Info
  • Curl
  • PHP
GET /api/?action=live.authRoomHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.authRoom&tokenID=&eventID=&roomId="
$response = InEvent\Live::authRoom($client, [
  "tokenID" => "",
  "eventID" => "",
  "roomId" => ""
]);

Auth for live stream.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

roomIdQUERY : room identifier

live.edit

( tokenID, liveID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=live.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=live.edit&tokenID=&liveID=&key=" \   -d "value="
$response = InEvent\Live::edit($client, [
  "tokenID" => "",
  "liveID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key at live liveID.

tokenIDQUERY : token identifier

liveIDQUERY : live identifier

keyQUERY : field name

{
    "ownerID": "person identifier",
    "roomName": "live name",
    "roomCover": "live cover"
}

valueBODY : field value

{
    "ownerID": "integer",
    "roomName": "string",
    "roomCover": "string"
}

live.remove

( tokenID, liveID )

  • Info
  • Curl
  • PHP
GET /api/?action=live.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.remove&tokenID=&liveID="
$response = InEvent\Live::remove($client, [
  "tokenID" => "",
  "liveID" => ""
]);

Removes live liveID.

tokenIDQUERY : token identifier

liveIDQUERY : live identifier

live.find

( tokenID, eventID, *selection )

  • Info
  • Curl
  • PHP
GET /api/?action=live.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.find&tokenID=&eventID="
$response = InEvent\Live::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Find lives for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*selectionQUERY : selection identifier

live.get

( *tokenID, *liveToken, liveID, *eventID, *personID )

  • Info
  • Curl
  • PHP
GET /api/?action=live.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.get&liveID="
$response = InEvent\Live::get($client, [
  "liveID" => ""
]);

Get live for event eventID.

*tokenIDQUERY : token identifier

*liveTokenQUERY : token identifier

liveIDQUERY : event identifier

*eventIDQUERY : event identifier

*personIDQUERY : event identifier

live.leave

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=live.leaveHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.leave&tokenID=&eventID="
$response = InEvent\Live::leave($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Leave current live.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

live.startRecording

( tokenID, eventID, liveID )

  • Info
  • Curl
  • PHP
GET /api/?action=live.startRecordingHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.startRecording&tokenID=&eventID=&liveID="
$response = InEvent\Live::startRecording($client, [
  "tokenID" => "",
  "eventID" => "",
  "liveID" => ""
]);

Starts a recording for live.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

liveIDQUERY : live identifier

live.updateRecording

( tokenID, eventID, liveID, personID, *multiple )

  • Info
  • Curl
  • PHP
GET /api/?action=live.updateRecordingHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.updateRecording&tokenID=&eventID=&liveID=&personID="
$response = InEvent\Live::updateRecording($client, [
  "tokenID" => "",
  "eventID" => "",
  "liveID" => "",
  "personID" => ""
]);

Updates a recording for live.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

liveIDQUERY : live identifier

personIDQUERY : person identifier

*multipleQUERY : multiple people

live.startLiveStreaming

( tokenID, eventID, liveID )

  • Info
  • Curl
  • PHP
GET /api/?action=live.startLiveStreamingHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.startLiveStreaming&tokenID=&eventID=&liveID="
$response = InEvent\Live::startLiveStreaming($client, [
  "tokenID" => "",
  "eventID" => "",
  "liveID" => ""
]);

Starts a live streaming.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

liveIDQUERY : live identifier

live.stopLiveStreaming

( tokenID, eventID, liveID )

  • Info
  • Curl
  • PHP
GET /api/?action=live.stopLiveStreamingHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.stopLiveStreaming&tokenID=&eventID=&liveID="
$response = InEvent\Live::stopLiveStreaming($client, [
  "tokenID" => "",
  "eventID" => "",
  "liveID" => ""
]);

Stops a live streaming.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

liveIDQUERY : live identifier

live.findTranscriptions

( tokenID, liveID )

  • Info
  • Curl
  • PHP
GET /api/?action=live.findTranscriptionsHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.findTranscriptions&tokenID=&liveID="
$response = InEvent\Live::findTranscriptions($client, [
  "tokenID" => "",
  "liveID" => ""
]);

Find live transcriptions.

tokenIDQUERY : token identifier

liveIDQUERY : live identifier

live.removeTranscriptions

( tokenID, liveID )

  • Info
  • Curl
  • PHP
GET /api/?action=live.removeTranscriptionsHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.removeTranscriptions&tokenID=&liveID="
$response = InEvent\Live::removeTranscriptions($client, [
  "tokenID" => "",
  "liveID" => ""
]);

Remove live transcriptions.

tokenIDQUERY : token identifier

liveIDQUERY : live identifier

live.analyticsFind

( tokenID, eventID, *selection, *order )

  • Info
  • Curl
  • PHP
GET /api/?action=live.analyticsFindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.analyticsFind&tokenID=&eventID="
$response = InEvent\Live::analyticsFind($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Find analytics live for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*selectionQUERY : live selection

*orderQUERY : live order

live.analyticsGet

( tokenID, eventID, liveID, *groupBy )

  • Info
  • Curl
  • PHP
GET /api/?action=live.analyticsGetHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.analyticsGet&tokenID=&eventID=&liveID="
$response = InEvent\Live::analyticsGet($client, [
  "tokenID" => "",
  "eventID" => "",
  "liveID" => ""
]);

Get analytics live for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

liveIDQUERY : live identifier

*groupByQUERY : group results by

Live Recording

Models

{
    "count": 1,
    "data": [
        {
            "*": "mixed"
        }
    ]
}

Methods

live.recording.remove

( tokenID, liveID, liveRecordingID )

  • Info
  • Curl
  • PHP
GET /api/?action=live.recording.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.recording.remove&tokenID=&liveID=&liveRecordingID="
$response = InEvent\Live.recording::remove($client, [
  "tokenID" => "",
  "liveID" => "",
  "liveRecordingID" => ""
]);

Removes a live recording liveRecordingID.

tokenIDQUERY : token identifier

liveIDQUERY : live identifier

liveRecordingIDQUERY : live recording identifier

live.recording.find

( tokenID, liveID )

  • Info
  • Curl
  • PHP
GET /api/?action=live.recording.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.recording.find&tokenID=&liveID="
$response = InEvent\Live.recording::find($client, [
  "tokenID" => "",
  "liveID" => ""
]);

Find live recordings for live liveID.

tokenIDQUERY : token identifier

liveIDQUERY : live identifier

live.recording.convert

( tokenID, liveID, liveRecordingID )

  • Info
  • Curl
  • PHP
GET /api/?action=live.recording.convertHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=live.recording.convert&tokenID=&liveID=&liveRecordingID="
$response = InEvent\Live.recording::convert($client, [
  "tokenID" => "",
  "liveID" => "",
  "liveRecordingID" => ""
]);

Convert live recording liveRecordingID.

tokenIDQUERY : token identifier

liveIDQUERY : live identifier

liveRecordingIDQUERY : live recording identifier

Lodging

You may provide lodging for your attendees during your event.

Models

{
    "count": 1,
    "data": [
        {
            "lodgingID": "3",
            "eventID": "1",
            "name": "Room #15",
            "description": "Two-bed room",
            "address": "5th Street",
            "capacity": "2"
        }
    ]
}

Methods

lodging.create

( tokenID, eventID, name, capacity, price, *description, *address )

  • Info
  • Curl
  • PHP
POST /api/?action=lodging.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=lodging.create&tokenID=&eventID=" \   -d "name=&capacity=&price="
$response = InEvent\Lodging::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "capacity" => "",
  "price" => ""
]);

Creates a room with name name and capacity capacity at event eventID .

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : room name

capacityBODY : max number of people allowed inside the room

priceBODY : room price

*descriptionBODY : room description

*addressBODY : hotel address

( tokenID, eventID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=lodging.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=lodging.create&tokenID=&eventID=" \   -d "path="
$response = InEvent\Lodging::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "path" => ""
]);

Creates multiple rooms at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

pathBODY : excel sheet url

lodging.edit

( tokenID, lodgingID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=lodging.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=lodging.edit&tokenID=&lodgingID=&key=" \   -d "value="
$response = InEvent\Lodging::edit($client, [
  "tokenID" => "",
  "lodgingID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of room lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

keyQUERY : field name

{
    "name": "name",
    "description": "description",
    "address": "address",
    "capacity": "capacity of people"
}

valueBODY : field value

{
    "name": "string",
    "description": "string",
    "address": "string",
    "capacity": "integer"
}

lodging.remove

( tokenID, lodgingID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.remove&tokenID=&lodgingID="
$response = InEvent\Lodging::remove($client, [
  "tokenID" => "",
  "lodgingID" => ""
]);

Removes lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

lodging.find

( tokenID, eventID, selection, sort, order )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.find&tokenID=&eventID=&selection=&sort=&order="
$response = InEvent\Lodging::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => "",
  "sort" => "",
  "order" => ""
]);

Gathers all rooms at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : specific selection

{
    "all": "all rooms",
    "empty": "available rooms"
}

sortQUERY : sort query

{
    "name": "filter by name",
    "description": "filter by description",
    "capacity": "filter by capacity",
    "price": "filter by price"
}

orderQUERY : direction sort query

{
    "ASC": "filter ascending",
    "DESC": "filter descending"
}

lodging.get

( tokenID, lodgingID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.get&tokenID=&lodgingID="
$response = InEvent\Lodging::get($client, [
  "tokenID" => "",
  "lodgingID" => ""
]);

Gathers room lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

lodging.stats

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.statsHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.stats&tokenID=&eventID="
$response = InEvent\Lodging::stats($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all lodging statistics at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

People at lodging

Defines which people are allowed inside the lodging.

Models

{
    "count": 1,
    "data": [
        {
            "lodgingPersonID": "16",
            "lodgingID": "4",
            "personID": "1330",
            "date": "124151252",
            "checkIn": "124151252",
            "checkOut": "124151252"
        }
    ]
}

Push Notification

lodging.person/added

_person

Notifies person personID about their allocation at lodging lodgingID.

{
    "lodgingID": "integer",
    "personID": "integer"
}

lodging.person/invited

_person

Notifies person personID about an invitation for lodging lodgingID.

{
    "lodgingID": "integer",
    "personID": "integer"
}

lodging.person/confirmed

_person

Notifies person that person personID accepted your invitation for lodging lodgingID.

{
    "lodgingID": "integer",
    "personID": "integer"
}

lodging.person/rejected

_person

Notifies person that person personID rejected your invitation for lodging lodgingID.

{
    "lodgingID": "integer",
    "personID": "integer"
}

Methods

lodging.person.bind

( tokenID, lodgingID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.person.bind&tokenID=&lodgingID="
$response = InEvent\Lodging.person::bind($client, [
  "tokenID" => "",
  "lodgingID" => ""
]);

Adds person tokenID to lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

( tokenID, lodgingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.person.bind&tokenID=&lodgingID=&personID="
$response = InEvent\Lodging.person::bind($client, [
  "tokenID" => "",
  "lodgingID" => "",
  "personID" => ""
]);

Adds person personID to lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

personIDQUERY : person identifier

lodging.person.dismiss

( tokenID, lodgingID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.person.dismiss&tokenID=&lodgingID="
$response = InEvent\Lodging.person::dismiss($client, [
  "tokenID" => "",
  "lodgingID" => ""
]);

Removes person tokenID at lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

( tokenID, lodgingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.person.dismiss&tokenID=&lodgingID=&personID="
$response = InEvent\Lodging.person::dismiss($client, [
  "tokenID" => "",
  "lodgingID" => "",
  "personID" => ""
]);

Removes personID at lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

personIDQUERY : person identifier

lodging.person.find

( tokenID, lodgingID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.person.find&tokenID=&lodgingID="
$response = InEvent\Lodging.person::find($client, [
  "tokenID" => "",
  "lodgingID" => ""
]);

Gathers all people at lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

( tokenID, eventID, selection, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.person.find&tokenID=&eventID=&selection="
$response = InEvent\Lodging.person::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Gathers all people at event eventID filtered by lodging.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : search

{
    "all": "all attendees",
    "hosted": "only hosted attendees",
    "non-hosted": "only non-hosted attendees"
}

*queryQUERY : query text

lodging.person.get

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.person.get&tokenID=&eventID="
$response = InEvent\Lodging.person::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers lodging for person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.person.get&tokenID=&eventID=&personID="
$response = InEvent\Lodging.person::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Gathers lodging for person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

lodging.person.invite

( tokenID, lodgingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.inviteHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.person.invite&tokenID=&lodgingID=&personID="
$response = InEvent\Lodging.person::invite($client, [
  "tokenID" => "",
  "lodgingID" => "",
  "personID" => ""
]);

Invites personID for lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

personIDQUERY : person identifier

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.inviteHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.person.invite&tokenID=&eventID=&personID="
$response = InEvent\Lodging.person::invite($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Invites person personID for lodging at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

lodging.person.inviteConfirm

( tokenID, lodgingID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.inviteConfirmHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.person.inviteConfirm&tokenID=&lodgingID="
$response = InEvent\Lodging.person::inviteConfirm($client, [
  "tokenID" => "",
  "lodgingID" => ""
]);

Confirms invitation at lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

lodging.person.inviteReject

( tokenID, lodgingID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.inviteRejectHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.person.inviteReject&tokenID=&lodgingID="
$response = InEvent\Lodging.person::inviteReject($client, [
  "tokenID" => "",
  "lodgingID" => ""
]);

Rejects invitation at lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

lodging.person.invites

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.invitesHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=lodging.person.invites&tokenID=&eventID="
$response = InEvent\Lodging.person::invites($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all invitations for lodgings at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

Marketo

Module specific for Marketo integrations. Our Marketo integration allows you to link lists from Marketo with us, simultaneously synchronizing leads from Marketo to our platform.

Methods

marketo.edit

( tokenID, companyID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=marketo.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=marketo.edit&tokenID=&companyID=&key=" \   -d "value="
$response = InEvent\Marketo::edit($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key from Marketo linked at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

keyQUERY : field name

{
    "autoLinkEvents": "should automatically link Marketo lists with Event main list",
    "autoLinkMode": "mode of linkage",
    "autoLinkFolderId": "list will be created at folder"
}

valueBODY : field value

{
    "autoLinkEvents": "boolean",
    "autoLinkMode": "r|w|rw",
    "autoLinkFolderId": "integer"
}

marketo.get

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.get&tokenID=&companyID="
$response = InEvent\Marketo::get($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Gathers Marketo integration details from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.get&tokenID=&eventID="
$response = InEvent\Marketo::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers Marketo integration details for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

marketo.linkAccount

( tokenID, companyID, clientId, clientSecret, munchkinId )

  • Info
  • Curl
  • PHP
POST /api/?action=marketo.linkAccountHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=marketo.linkAccount&tokenID=&companyID=" \   -d "clientId=&clientSecret=&munchkinId="
$response = InEvent\Marketo::linkAccount($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "clientId" => "",
  "clientSecret" => "",
  "munchkinId" => ""
]);

Links a Marketo account with company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

clientIdBODY : Marketo client identifier

clientSecretBODY : Marketo client secret

munchkinIdBODY : Marketo munchkin identifier

marketo.unlinkAccount

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.unlinkAccountHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.unlinkAccount&tokenID=&companyID="
$response = InEvent\Marketo::unlinkAccount($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Unlinks a Marketo account from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

marketo.getFolders

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.getFoldersHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.getFolders&tokenID=&companyID="
$response = InEvent\Marketo::getFolders($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Get a list of folders available for linkage from Marketo at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

marketo.getChannels

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.getChannelsHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.getChannels&tokenID=&companyID="
$response = InEvent\Marketo::getChannels($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Get a list of channels available for linkage from Marketo at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

marketo.getTags

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.getTagsHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.getTags&tokenID=&companyID="
$response = InEvent\Marketo::getTags($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Get a list of tags available for linkage from Marketo at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

marketo.getTypes

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.getTypesHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.getTypes&tokenID="
$response = InEvent\Marketo::getTypes($client, [
  "tokenID" => ""
]);

Get a list of types available for linkage from Marketo.

tokenIDQUERY : token identifier

marketo.getProgram

( tokenID, companyID, name )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.getProgramHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.getProgram&tokenID=&companyID=&name="
$response = InEvent\Marketo::getProgram($client, [
  "tokenID" => "",
  "companyID" => "",
  "name" => ""
]);

Get a program by its name from Marketo.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

nameQUERY : program name

marketo.import

( tokenID, eventID, mktListID, target, *targetID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.importHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.import&tokenID=&eventID=&mktListID=&target="
$response = InEvent\Marketo::import($client, [
  "tokenID" => "",
  "eventID" => "",
  "mktListID" => "",
  "target" => ""
]);

Import list leads from Marketo mktListID to a target and targetID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

mktListIDQUERY : marketo list identifier

targetQUERY : target list

{
    "event.person": "attendees list",
    "event.invite": "invitees list",
    "list": "custom list (requires targetID)"
}

*targetIDQUERY : target list id

Marketo Field

This module allows you to link an InEvent field with a Marketo field.

Methods

marketo.field.bind

( tokenID, eventID, feedbackID, mkFieldId )

  • Info
  • Curl
  • PHP
POST /api/?action=marketo.field.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=marketo.field.bind&tokenID=&eventID=" \   -d "feedbackID=&mkFieldId="
$response = InEvent\Marketo.field::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "feedbackID" => "",
  "mkFieldId" => ""
]);

Links a Marketo field to event eventID and a field feedbackID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

feedbackIDBODY : InEvent field identifier

mkFieldIdBODY : Marketo field identifier

marketo.field.dismiss

( tokenID, marketoFieldID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.field.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.field.dismiss&tokenID=&marketoFieldID="
$response = InEvent\Marketo.field::dismiss($client, [
  "tokenID" => "",
  "marketoFieldID" => ""
]);

Unlinks a Marketo field marketoFieldID from event.

tokenIDQUERY : token identifier

marketoFieldIDQUERY : linkage identifier

( tokenID, feedbackID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.field.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.field.dismiss&tokenID=&feedbackID="
$response = InEvent\Marketo.field::dismiss($client, [
  "tokenID" => "",
  "feedbackID" => ""
]);

Unlinks a Marketo field linked with feedbackID from event.

tokenIDQUERY : token identifier

feedbackIDQUERY : feedback identifier

marketo.field.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.field.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.field.find&tokenID=&eventID="
$response = InEvent\Marketo.field::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Finds all linked fields between Marketo and InEvent at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

marketo.field.get

( tokenID, marketoFieldID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.field.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.field.get&tokenID=&marketoFieldID="
$response = InEvent\Marketo.field::get($client, [
  "tokenID" => "",
  "marketoFieldID" => ""
]);

Get a specific linkage field marketoFieldID between Marketo and InEvent.

tokenIDQUERY : token identifier

marketoFieldIDQUERY : linkage identifier

Marketo Link

This module allows you to link an InEvent list with a Marketo list.

Methods

marketo.link.bind

( tokenID, eventID, listID, linkId, mode )

  • Info
  • Curl
  • PHP
POST /api/?action=marketo.link.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=marketo.link.bind&tokenID=&eventID=" \   -d "listID=&linkId=&mode="
$response = InEvent\Marketo.link::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "listID" => "",
  "linkId" => "",
  "mode" => ""
]);

Links a Marketo list to event eventID and a list listID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

listIDBODY : InEvent list identifier

linkIdBODY : Marketo list identifier

modeBODY : linkage mode

{
    "r": "read only (InEvent reads from Marketo)",
    "w": "write only (InEvent writes to Marketo)",
    "rw": "read\/write (InEvent reads and writes on Marketo)"
}

( tokenID, eventID, linkId, mode )

  • Info
  • Curl
  • PHP
POST /api/?action=marketo.link.bindHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=marketo.link.bind&tokenID=&eventID=" \   -d "linkId=&mode="
$response = InEvent\Marketo.link::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "linkId" => "",
  "mode" => ""
]);

Links a Marketo program to event eventID attendees list.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

linkIdBODY : Marketo program identifier

modeBODY : linkage mode

{
    "r": "read only (InEvent reads from Marketo)",
    "w": "write only (InEvent writes to Marketo)",
    "rw": "read\/write (InEvent reads and writes on Marketo)"
}

marketo.link.operate

( tokenID, marketoLinkID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=marketo.link.operateHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=marketo.link.operate&tokenID=&marketoLinkID=&key=" \   -d "value="
$response = InEvent\Marketo.link::operate($client, [
  "tokenID" => "",
  "marketoLinkID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key for a linkage marketoLinkID.

tokenIDQUERY : token identifier

marketoLinkIDQUERY : activity identifier

keyQUERY : element name

{
    "mode": "approval status"
}

valueBODY : desired action

{
    "r": "read only (InEvent reads from Marketo)",
    "w": "write only (InEvent writes to Marketo)",
    "rw": "read\/write (InEvent reads and writes on Marketo)"
}

marketo.link.dismiss

( tokenID, marketoLinkID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.link.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.link.dismiss&tokenID=&marketoLinkID="
$response = InEvent\Marketo.link::dismiss($client, [
  "tokenID" => "",
  "marketoLinkID" => ""
]);

Unlinks a Marketo list marketoLinkID from event.

tokenIDQUERY : token identifier

marketoLinkIDQUERY : linkage identifier

marketo.link.createProgram

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.link.createProgramHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.link.createProgram&tokenID=&eventID="
$response = InEvent\Marketo.link::createProgram($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Creates a new Marketo program based on eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

marketo.link.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.link.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.link.find&tokenID=&eventID="
$response = InEvent\Marketo.link::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Finds all linked lists between Marketo and InEvent at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

marketo.link.get

( tokenID, marketoLinkID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.link.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.link.get&tokenID=&marketoLinkID="
$response = InEvent\Marketo.link::get($client, [
  "tokenID" => "",
  "marketoLinkID" => ""
]);

Get a specific linkage list marketoLinkID between Marketo and InEvent.

tokenIDQUERY : token identifier

marketoLinkIDQUERY : linkage identifier

marketo.link.sync

( tokenID, marketoLinkID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.link.syncHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=marketo.link.sync&tokenID=&marketoLinkID="
$response = InEvent\Marketo.link::sync($client, [
  "tokenID" => "",
  "marketoLinkID" => ""
]);

Forces a synchronization between Marketo and InEvent for linkage list marketoLinkID.

tokenIDQUERY : token identifier

marketoLinkIDQUERY : linkage identifier

Material

In each activity you can share materials such as documents, presentations and images. This allows multiple resources to quickly become accessible to many people within the event, minimizing the data loss process. Each material receives an unique url.

Models

{
    "count": 1,
    "data": [
        {
            "materialID": "1",
            "activityID": "1012",
            "sponsorID": "",
            "name": "file.pdf",
            "extension": "",
            "url": "https:\/\/www.dropbox.com\/s\/",
            "date": "1385523142"
        }
    ]
}

Methods

material.create

( tokenID, activityID, name, extension, url )

  • Info
  • Curl
  • PHP
POST /api/?action=material.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=material.create&tokenID=&activityID=" \   -d "name=&extension=&url="
$response = InEvent\Material::create($client, [
  "tokenID" => "",
  "activityID" => ""
], [
  "name" => "",
  "extension" => "",
  "url" => ""
]);

Creates a material with name name and hosted at url at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

nameBODY : file name

extensionBODY : file extension

urlBODY : file url

( tokenID, sponsorID, name, extension, url )

  • Info
  • Curl
  • PHP
POST /api/?action=material.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=material.create&tokenID=&sponsorID=" \   -d "name=&extension=&url="
$response = InEvent\Material::create($client, [
  "tokenID" => "",
  "sponsorID" => ""
], [
  "name" => "",
  "extension" => "",
  "url" => ""
]);

Creates a material with name name and hosted at url at sponsor sponsorID.

tokenIDQUERY : token identifier

sponsorIDQUERY : sponsor identifier

nameBODY : file name

extensionBODY : file extension

urlBODY : file url

( tokenID, eventID, name, extension, url )

  • Info
  • Curl
  • PHP
POST /api/?action=material.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=material.create&tokenID=&eventID=" \   -d "name=&extension=&url="
$response = InEvent\Material::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "extension" => "",
  "url" => ""
]);

Creates a material with name name and hosted at url at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : file name

extensionBODY : file extension

urlBODY : file url

material.remove

( tokenID, materialID )

  • Info
  • Curl
  • PHP
GET /api/?action=material.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=material.remove&tokenID=&materialID="
$response = InEvent\Material::remove($client, [
  "tokenID" => "",
  "materialID" => ""
]);

Removes material materialID.

tokenIDQUERY : token identifier

materialIDQUERY : material identifier

material.find

( tokenID, activityID, *withAnalytics )

  • Info
  • Curl
  • PHP
GET /api/?action=material.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=material.find&tokenID=&activityID="
$response = InEvent\Material::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Gathers all materials from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

*withAnalyticsQUERY : should return with analytics (only for admins)

( tokenID, sponsorID, *withAnalytics )

  • Info
  • Curl
  • PHP
GET /api/?action=material.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=material.find&tokenID=&sponsorID="
$response = InEvent\Material::find($client, [
  "tokenID" => "",
  "sponsorID" => ""
]);

Gathers all materials from sponsor sponsorID.

tokenIDQUERY : token identifier

sponsorIDQUERY : sponsor identifier

*withAnalyticsQUERY : should return with analytics (only for admins)

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=material.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=material.find&tokenID=&eventID="
$response = InEvent\Material::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all materials from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

material.get

( tokenID, materialID )

  • Info
  • Curl
  • PHP
GET /api/?action=material.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=material.get&tokenID=&materialID="
$response = InEvent\Material::get($client, [
  "tokenID" => "",
  "materialID" => ""
]);

Gathers material materialID.

tokenIDQUERY : token identifier

materialIDQUERY : material identifier

Material tags

You can tag each material so it is easier for attendees to find a specific material and for organizers to better manage their materials.

Models

{
    "count": 1,
    "data": [
        {
            "materialID": "1",
            "tagID": "1300"
        }
    ]
}

Methods

material.tag.bind

( tokenID, materialID, tagID )

  • Info
  • Curl
  • PHP
GET /api/?action=material.tag.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=material.tag.bind&tokenID=&materialID=&tagID="
$response = InEvent\Material.tag::bind($client, [
  "tokenID" => "",
  "materialID" => "",
  "tagID" => ""
]);

Creates tag tagID at material materialID.

tokenIDQUERY : token identifier

materialIDQUERY : material identifier

tagIDQUERY : tag identifier

material.tag.dismiss

( tokenID, materialID, tagID )

  • Info
  • Curl
  • PHP
GET /api/?action=material.tag.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=material.tag.dismiss&tokenID=&materialID=&tagID="
$response = InEvent\Material.tag::dismiss($client, [
  "tokenID" => "",
  "materialID" => "",
  "tagID" => ""
]);

Removes tag tagID from material materialID.

tokenIDQUERY : token identifier

materialIDQUERY : material identifier

tagIDQUERY : tag identifier

material.tag.find

( tokenID, materialID )

  • Info
  • Curl
  • PHP
GET /api/?action=material.tag.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=material.tag.find&tokenID=&materialID="
$response = InEvent\Material.tag::find($client, [
  "tokenID" => "",
  "materialID" => ""
]);

Gathers all tags for material materialID.

tokenIDQUERY : token identifier

materialIDQUERY : material identifier

Meeting

During the participating events (guests) they can schedule meetings with other participants of the event (hosts). Hosts set the times and guests can schedule meetings at these times.

Models

{
    "count": 1,
    "data": [
        {
            "meetingID": "4",
            "eventID": "6026",
            "personID": "449",
            "dateBegin": "1449803077",
            "dateEnd": "1449806377",
            "placeID": "1223",
            "capacity": "2",
            "maySubscribe": 1,
            "guests": [
                {
                    "meetingPersonID": "12",
                    "personID": "525",
                    "personName": "Dave Grohl",
                    "status": "1",
                    "checkIn": "0"
                },
                {
                    "meetingPersonID": "16",
                    "personID": "1330",
                    "personName": "Josh Homme",
                    "status": "1",
                    "checkIn": "1"
                }
            ]
        }
    ]
}

Push Notification

meeting/change

_guest

Informs person personID that the meeting meetingID has been updated.

{
    "meetingID": "integer"
}

Methods

meeting.create

( tokenID, eventID, *personID, dateBegin, dateEnd, placeID, capacity, *duration, isRange )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=meeting.create&tokenID=&eventID=" \   -d "dateBegin=&dateEnd=&placeID=&capacity=&isRange="
$response = InEvent\Meeting::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "dateBegin" => "",
  "dateEnd" => "",
  "placeID" => "",
  "capacity" => "",
  "isRange" => ""
]);

Creates a range of time slots that starts at dateBegin and ends at dateEnd with duration of duration for meetings located at placeID for host tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*personIDQUERY : meeting host identifier

dateBeginBODY : time that the meeting starts

dateEndBODY : time that the meeting ends

placeIDBODY : meeting place identifier

capacityBODY : amount of people allowed to participate at the meeting

*durationBODY : duration time of a meeting for range creation

isRangeBODY : defines if begin and end dates are a range or only a meeting

( tokenID, eventID, *personID, dateBegin, dateEnd, placeID, capacity )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=meeting.create&tokenID=&eventID=" \   -d "dateBegin=&dateEnd=&placeID=&capacity="
$response = InEvent\Meeting::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "dateBegin" => "",
  "dateEnd" => "",
  "placeID" => "",
  "capacity" => ""
]);

Creates a time slot that starts at dateBegin and ends at dateEnd for meetings located at placeID for host tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*personIDQUERY : meeting host identifier

dateBeginBODY : time that the meeting starts

dateEndBODY : time that the meeting ends

placeIDBODY : meeting place identifier

capacityBODY : amount of people allowed to participate at the meeting

( tokenID, eventID, *personID, dateBegin, dateEnd, capacity, *duration, isRange )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=meeting.create&tokenID=&eventID=" \   -d "dateBegin=&dateEnd=&capacity=&isRange="
$response = InEvent\Meeting::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "dateBegin" => "",
  "dateEnd" => "",
  "capacity" => "",
  "isRange" => ""
]);

Creates a range of time slots that starts at dateBegin and ends at dateEnd with duration of duration for meetings located at placeID for host tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*personIDQUERY : meeting host identifier

dateBeginBODY : time that the meeting starts

dateEndBODY : time that the meeting ends

capacityBODY : amount of people allowed to participate at the meeting

*durationBODY : duration time of a meeting for range creation

isRangeBODY : defines if begin and end dates are a range or only a meeting

( tokenID, eventID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=meeting.create&tokenID=&eventID=" \   -d "path="
$response = InEvent\Meeting::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "path" => ""
]);

Creates multiple meetings at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

pathBODY : meetings excel sheet url

meeting.edit

( tokenID, meetingID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=meeting.edit&tokenID=&meetingID=&key=" \   -d "value="
$response = InEvent\Meeting::edit($client, [
  "tokenID" => "",
  "meetingID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

keyQUERY : field name

{
    "dateBegin": "date and time",
    "dateEnd": "date and time",
    "placeID": "place identifier",
    "status": "status"
}

valueBODY : field value

{
    "dateBegin": "integer(11)",
    "dateEnd": "integer(11)",
    "placeID": "place identifier",
    "status": "status"
}

meeting.remove

( tokenID, meetingID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.remove&tokenID=&meetingID="
$response = InEvent\Meeting::remove($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Removes meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

meeting.find

( tokenID, eventID, *personID, placeID, *dateBegin, *dateEnd, *capacity, *selection, *offset, *paginated )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.find&tokenID=&eventID=&placeID="
$response = InEvent\Meeting::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "placeID" => ""
]);

Gathers all meetings at event eventID hosted by personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*personIDQUERY : person identifier

placeIDQUERY : place identifier

*dateBeginQUERY : date and time of start

*dateEndQUERY : date and time of end

*capacityQUERY : capacity of slot, when it is 0, this slot is restriction slot

*selectionQUERY : selection if show all slots or just slot with hosts

*offsetQUERY : pagination offset

*paginatedQUERY : activate pagination

( tokenID, eventID, *personID, placeCategory, *dateBegin, *dateEnd, *selection, *offset, *paginated )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.find&tokenID=&eventID=&placeCategory="
$response = InEvent\Meeting::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "placeCategory" => ""
]);

Gathers all meetings at event eventID by placeCategory.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*personIDQUERY : person identifier

placeCategoryQUERY : place category identifier

*dateBeginQUERY : date and time of start

*dateEndQUERY : date and time of end

*selectionQUERY : selection if show all slots or just slot with hosts

*offsetQUERY : pagination offset

*paginatedQUERY : activate pagination

( tokenID, eventID, *personID, *dateBegin, *dateEnd, *capacity, *selection, *offset, *paginated )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.find&tokenID=&eventID="
$response = InEvent\Meeting::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all meetings at event eventID related to tokenID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*personIDQUERY : person identifier

*dateBeginQUERY : date and time of start

*dateEndQUERY : date and time of end

*capacityQUERY : capacity of slot, when it is 0, this slot is restriction

*selectionQUERY : selection if show all slots or just slot with hosts

*offsetQUERY : pagination offset

*paginatedQUERY : activate pagination

( tokenID, eventID, *dateBegin, *dateEnd )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.find&tokenID=&eventID="
$response = InEvent\Meeting::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all meetings at event eventID hosted by personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*dateBeginQUERY : date and time of start

*dateEndQUERY : date and time of end

( tokenID, eventID, *personID, *dateBegin, *dateEnd )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.find&tokenID=&eventID="
$response = InEvent\Meeting::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all meetings at event eventID hosted by personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*personIDQUERY : person identifier

*dateBeginQUERY : date and time of start

*dateEndQUERY : date and time of end

meeting.get

( tokenID, meetingID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.get&tokenID=&meetingID="
$response = InEvent\Meeting::get($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Gathers meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

( tokenID, meetingID, *capacity )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.get&tokenID=&meetingID="
$response = InEvent\Meeting::get($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Gathers meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

*capacityQUERY : capacity of slot, when it is 0, this slot is restriction

meeting.getDays

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.getDaysHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.getDays&tokenID=&eventID="
$response = InEvent\Meeting::getDays($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns meeting days for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

meeting.fill

( tokenID, eventID, minutes )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.fillHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=meeting.fill&tokenID=&eventID=" \   -d "minutes="
$response = InEvent\Meeting::fill($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "minutes" => ""
]);

Fill all meetings at event eventID with intervals of minutes.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

minutesBODY : intervals of x minutes

meeting.removeAll

( tokenID, eventID, *personID, *capacity, *placeCategory )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.removeAllHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.removeAll&tokenID=&eventID="
$response = InEvent\Meeting::removeAll($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Remove all meetings for personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*personIDQUERY : person identifier

*capacityQUERY : slot kind

*placeCategoryQUERY : slots per place category

meeting.stats

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.statsHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.stats&tokenID=&eventID="
$response = InEvent\Meeting::stats($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Get data about meetings at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

Meeting feedback

At the end of the meeting, people that participated may send a feedback.

Models

{
    "count": 1,
    "data": [
        {
            "meetingFeedbackID": "16",
            "meetingID": "4",
            "personID": "1330",
            "text": "Awesome meeting!"
        }
    ]
}

Push Notification

meeting/feedback

_host|guest

Notifies people from meeting to send their feedback.

{
    "meetingID": "integer",
    "personID": "integer"
}

Methods

meeting.feedback.create

( tokenID, meetingID, text )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.feedback.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=meeting.feedback.create&tokenID=&meetingID=" \   -d "text="
$response = InEvent\Meeting.feedback::create($client, [
  "tokenID" => "",
  "meetingID" => ""
], [
  "text" => ""
]);

Creates a feedback with text text for the meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

textBODY : feedback text

meeting.feedback.find

( tokenID, meetingID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.feedback.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.feedback.find&tokenID=&meetingID="
$response = InEvent\Meeting.feedback::find($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Gathers feedback for meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

Meeting people

Meetings marked during the event can be changed, confirmed, rejected or canceled depending on host or guest actions.

Models

{
    "count": 1,
    "data": [
        {
            "meetingPersonID": "16",
            "meetingID": "4",
            "personID": "1330",
            "status": "1",
            "checkIn": 1
        }
    ]
}

Push Notification

meeting/ask

_host

Notifies host hostID of meeting that person personID wishes to participate as guest.

{
    "meetingID": "integer",
    "personID": "integer"
}

meeting/confirm

_guest

Notifies guest personID that meeting meetingID has been confirmed.

{
    "meetingID": "integer"
}

meeting/revoke

_guest

Notifies guest personID that meeting meetingID has been rejected.

{
    "meetingID": "integer"
}

Methods

meeting.person.bind

( tokenID, meetingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.person.bind&tokenID=&meetingID=&personID="
$response = InEvent\Meeting.person::bind($client, [
  "tokenID" => "",
  "meetingID" => "",
  "personID" => ""
]);

Adds guest personID to meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

personIDQUERY : person identifier

( tokenID, meetingID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.person.bind&tokenID=&meetingID="
$response = InEvent\Meeting.person::bind($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Adds guest tokenID to meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

meeting.person.confirm

( tokenID, meetingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.confirmHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.person.confirm&tokenID=&meetingID=&personID="
$response = InEvent\Meeting.person::confirm($client, [
  "tokenID" => "",
  "meetingID" => "",
  "personID" => ""
]);

Confirms meeting meetingID with guest personID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

personIDQUERY : host identifier

meeting.person.revoke

( tokenID, meetingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.revokeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.person.revoke&tokenID=&meetingID=&personID="
$response = InEvent\Meeting.person::revoke($client, [
  "tokenID" => "",
  "meetingID" => "",
  "personID" => ""
]);

Rejects meeting meetingID with guest personID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

personIDQUERY : host identifier

meeting.person.dismiss

( tokenID, meetingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.person.dismiss&tokenID=&meetingID=&personID="
$response = InEvent\Meeting.person::dismiss($client, [
  "tokenID" => "",
  "meetingID" => "",
  "personID" => ""
]);

Cancels their presence at meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

personIDQUERY : person identifier

( tokenID, meetingID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.person.dismiss&tokenID=&meetingID="
$response = InEvent\Meeting.person::dismiss($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Cancels their presence at meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

meeting.person.dismissAll

( tokenID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.dismissAllHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.person.dismissAll&tokenID=&personID="
$response = InEvent\Meeting.person::dismissAll($client, [
  "tokenID" => "",
  "personID" => ""
]);

Cancels presence at all meetings that belongs to personID.

tokenIDQUERY : token identifier

personIDQUERY : person identifier

meeting.person.checkIn

( tokenID, meetingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.checkInHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.person.checkIn&tokenID=&meetingID=&personID="
$response = InEvent\Meeting.person::checkIn($client, [
  "tokenID" => "",
  "meetingID" => "",
  "personID" => ""
]);

Confirms their presence at meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

personIDQUERY : person identifier

( tokenID, meetingID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.checkInHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.person.checkIn&tokenID=&meetingID="
$response = InEvent\Meeting.person::checkIn($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Confirms their presence at meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

meeting.person.matchMaking

( tokenID, eventID, personID, *matchOperation, *tagsMatch, *tagsException )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.person.matchMakingHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=meeting.person.matchMaking&tokenID=&eventID=&personID=" \   -d ""
$response = InEvent\Meeting.person::matchMaking($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
], [

]);

Generate a person list for meetings at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : meeting host

*matchOperationQUERY : preview or execute matchmaking

*tagsMatchBODY : tags for matchmaking criteria

*tagsExceptionBODY : excludent tags for matchmaking criteria

meeting.person.getWaitlist

( tokenID, eventID, personID, meetingID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.getWaitlistHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.person.getWaitlist&tokenID=&eventID=&personID=&meetingID="
$response = InEvent\Meeting.person::getWaitlist($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => "",
  "meetingID" => ""
]);

Get meeting waitlist for host personID eligible for meetingID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : meeting host

meetingIDQUERY : return only eligible person for enrollment in this meeting

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.getWaitlistHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.person.getWaitlist&tokenID=&eventID=&personID="
$response = InEvent\Meeting.person::getWaitlist($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Get meeting waitlist for host personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : meeting host

meeting.person.clearWaitlist

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.clearWaitlistHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.person.clearWaitlist&tokenID=&eventID=&personID="
$response = InEvent\Meeting.person::clearWaitlist($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Clear waitlist for host personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : meeting host

meeting.person.withSlot

( tokenID, eventID, *selection, *query, *wishlist )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.withSlotHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.person.withSlot&tokenID=&eventID="
$response = InEvent\Meeting.person::withSlot($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Get meeting persons with slots, simple slots or restriction slots or both.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*selectionQUERY : meeting person slots kind

{
    "withCapacity": "just people with slots capacity more than 0",
    "restriction": "just people with restriction slots",
    "all": "all people"
}

*queryQUERY : search query

*wishlistQUERY : search on wishlist only

Meeting quotas

For each attendee of the event, there is a maximum number of meetings you can dial with the hosts. This number is defined through quotas, which can be created and assigned to different participants. Participants without quotas can not schedule any meetings.

Models

{
    "count": 1,
    "data": [
        {
            "meetingQuotaID": "1",
            "eventID": "1",
            "name": "Gold package",
            "amount": "10"
        }
    ]
}

Methods

meeting.quota.create

( tokenID, eventID, name, amount )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.quota.createHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=meeting.quota.create&tokenID=&eventID=" \   -d "name=&amount="
$response = InEvent\Meeting.quota::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "amount" => ""
]);

Creates a quota with name name and amount of meetings amount at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : quota name

amountBODY : amount of meetings for quota

meeting.quota.get

( tokenID, meetingQuotaID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.quota.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.quota.get&tokenID=&meetingQuotaID="
$response = InEvent\Meeting.quota::get($client, [
  "tokenID" => "",
  "meetingQuotaID" => ""
]);

Gathers quota meetingQuotaID.

tokenIDQUERY : token identifier

meetingQuotaIDQUERY : quota identifier

meeting.quota.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.quota.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.quota.find&tokenID=&eventID="
$response = InEvent\Meeting.quota::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all quotas at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

meeting.quota.edit

( tokenID, meetingQuotaID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.quota.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=meeting.quota.edit&tokenID=&meetingQuotaID=&key=" \   -d "value="
$response = InEvent\Meeting.quota::edit($client, [
  "tokenID" => "",
  "meetingQuotaID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of quota meetingQuotaID.

tokenIDQUERY : token identifier

meetingQuotaIDQUERY : quota identifier

keyQUERY : field name

{
    "name": "quota name",
    "amount": "amount of meetings"
}

valueBODY : field value

{
    "name": "string",
    "amount": "integer(11)"
}

meeting.quota.remove

( tokenID, eventID, meetingQuotaID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.quota.removeHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.quota.remove&tokenID=&eventID=&meetingQuotaID="
$response = InEvent\Meeting.quota::remove($client, [
  "tokenID" => "",
  "eventID" => "",
  "meetingQuotaID" => ""
]);

Removes quota meetingQuotaID from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

meetingQuotaIDQUERY : quota identifier

Meeting wishlist

Attendees may create their own wishlist of people they want to talk to during the event.

Models

{
    "count": 1,
    "data": [
        {
            "meetingWishlistID": "1",
            "eventID": "1",
            "personID": "5",
            "targetID": "10"
        }
    ]
}

Methods

meeting.wishlist.bind

( tokenID, eventID, targetID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.wishlist.bindHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.wishlist.bind&tokenID=&eventID=&targetID="
$response = InEvent\Meeting.wishlist::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "targetID" => ""
]);

Creates a wish entry for person targetID at the event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

targetIDQUERY : person identifier

meeting.wishlist.dismiss

( tokenID, eventID, targetID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.wishlist.dismissHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.wishlist.dismiss&tokenID=&eventID=&targetID="
$response = InEvent\Meeting.wishlist::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "targetID" => ""
]);

Removes a wish entry for person targetID at the event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

targetIDQUERY : person identifier

meeting.wishlist.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.wishlist.findHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=meeting.wishlist.find&tokenID=&eventID="
$response = InEvent\Meeting.wishlist::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all wish entries for person at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

Moip

Module destinated for integrations between InEvent and Moip.

Methods

moip.get

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=moip.getHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=moip.get&tokenID=&eventID="
$response = InEvent\Moip::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers data from Moip integration at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

moip.edit

( tokenID, eventID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=moip.editHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=moip.edit&tokenID=&eventID=&key=" \   -d "value="
$response = InEvent\Moip::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits data from Moip integration at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : field name

{
    "installments": "number of maximum installments"
}

valueBODY : field value

{
    "installments": "integer (from 1 to 12)"
}

moip.linkAccount

( tokenID, eventID, apiKey, apiToken, sandbox )

  • Info
  • Curl
  • PHP
POST /api/?action=moip.linkAccountHTTP/1.1 Host: app.inevent.com
$ curl -X POST "https://app.inevent.com/api/?action=moip.linkAccount&tokenID=&eventID=" \   -d "apiKey=&apiToken=&sandbox="
$response = InEvent\Moip::linkAccount($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "apiKey" => "",
  "apiToken" => "",
  "sandbox" => ""
]);

Links a Moip account with event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

apiKeyBODY : Moip api key

apiTokenBODY : Moip api token

sandboxBODY : sandbox environment or production (1 or 0)

moip.unlinkAccount

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=moip.unlinkAccountHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=moip.unlinkAccount&tokenID=&eventID="
$response = InEvent\Moip::unlinkAccount($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Unlinks a Moip account from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

Mux

Manages Mux operations for video playbacks on any resource.

Models

{
    "count": 1,
    "data": [
        {
            "url": "https:\/\/storage.googleapis.com\/video-storage-us-east1-uploads\/-----",
            "timeout": 3600,
            "status": "waiting",
            "new_asset_settings": {
                "playback_policies": [
                    "public"
                ]
            },
            "id": "Z9BBc8zc7mfWwOiUvAcQAn01LYKop02ZIPMPuYMc01oCQs",
            "cors_origin": "https:\/\/app.inevent.com"
        }
    ]
}

Methods

mux.createDirectUpload

( tokenID, eventID, target, targetID )

  • Info
  • Curl
  • PHP
GET /api/?action=mux.createDirectUploadHTTP/1.1 Host: app.inevent.com
$ curl -X GET "https://app.inevent.com/api/?action=mux.createDirectUpload&tokenID=&eventID=&target=&targetID="
$response = InEvent\Mux::createDirectUpload($client, [
  "tokenID" => "",
  "eventID" => "",
  "target" => "",
  "targetID" => ""
]);

Gather a direct upload info for Mux.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

targetQUERY : target type

targetIDQUERY : target identifier

News

For each event, it is necessary to actively communicate everything that occurs at exact moments. For each news, you are allowed to choose your recipient, such as people from the entire event, activity or even individually.

Models

{
    "count": 1,
    "data": [
        {
            "newsID": "4",
            "eventID": "1",
            "activityID": "15",
            "senderID": "0",
            "senderRole": "1",
            "receiverID": "0",
            "message": "Event is starting!",
            "date": "1400524839",
            "sent": true,
            "activityName": "Opening",
            "senderName": null,
            "receiverName": null
        }
    ]
}
{
    "senderRole": {
        "1": "ROLE_ATTENDEE",
        "2": "ROLE_STAFF",
        "4": "ROLE_COORDINATOR"
    }
}

Push Notification

news/event.create

_event

Notifies message for event eventID.

{
    "eventID": "integer"
}

news/activity.create

_event

Notifies message for activity activityID at event eventID.

{
    "activityID": "integer"
}

news/person.create

_person

Notifies message for person personID.

{
    "personID": "integer"
}

news/list.create

_list

Notifies message for list listID.

{
    "listID": "integer"
}

Methods

news.create

( tokenID, eventID, personID, message, *channel, *scheduled, *date )

  • Info
  • Curl
  • PHP
POST /api/?