Lucid 6.3 supports getting events information and executing events using the API.
The default response for our API calls is a JSON content, with the following structure:
{
bool success,
string message,
object data
}
The data object may be a generic object, an EventList class type, or Event, accordingly:
Event class type definition:
{
string id,
string name,
string color,
string thumbnail
}
EventList class type definition is an array of Event objects:
{
Event[] events
}
Lucid 6.3+ API supports the following endpoints:
- Get Event List
- HTTP Method: GET
- Endpoint: /event/list
- Parameters:
- Lucid API Key: api_key
- Response:
-
- Content Type: JSON
- Structure:
- success (bool)
- message (string)
- data (EventList)
-
- Get Event Information
- HTTP Method: GET
- Endpoint: /event/get
- Parameters:
- Lucid Event ID: id
- Lucid API Key: api_key
- Response:
- Content Type: JSON
- Structure:
-
- success (bool)
- message (string)
- data (Event)
-
- Execute Event
- HTTP Method: POST
- Encoding: URL-Encoded Form (application/x-www-form-urlencoded)
- Endpoint: /event/execute
- Parameters:
- Lucid Event ID: id
- Lucid API Key: api_key
- Response:
- Content Type: JSON
- Structure:
- success (bool)
- message (string)
- data (object)
- HTTP Method: POST