Corsizio¶
The Corsizio modules allow you to retrieve and list the events and attendees in your Corsizio account.
Getting Started with Corsizio¶
Prerequisites
- A Corsizio account
In order to use Corsizio with Ibexa Connect, it is necessary to have a Corsizio account. If you do not have one, you can create a Corsizio account at manager.corsizio.com/signup.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Corsizio to Ibexa Connect¶
To connect your Corsizio account to Ibexa Connect you need to obtain the API Key from your Corsizio account and insert it in the Create a connection dialog in the Ibexa Connect module.
1. Log in to your Corsizio account.
2. Click Your Profile Icon > Account Settings > Integrations > Developer API Integration > Generate a New API Secret Key. Copy the API Secret Key to your Clipboard.
3. Go to Ibexa Connect and open the Corsizio module's Create a connection dialog.
4. In the Connection name field, enter a name for the connection.
5. In the API Secret Key field, enter the API secret key copied in step 2, and click Continue.
The connection has been established.
Events¶
Get an Event¶
Retrieves details about a specified event.
| Event ID | Select the Event ID whose details you want to retrieve. |
| Include | Add the options to include in the event details. For example, attendees, payment. |
| Expand | Add the option you want to expand with detailed information in the event result. |
List Events¶
Returns a list of events based on the selected filters.
| Limit | Set the maximum number of events Ibexa Connect should return during one scenario execution cycle. |
| Order | Select the order in which you want to list the events: * Created * Start Date * End Date |
| Status | Select the status of the events you want to list: * Any * Published * Draft * Archived * Deleted |
| From | Enter the date to list the events created or updated on or after the specified date. |
| To | Enter the date to list the events created or updated on or before the specified date. |
| From | Enter the date to list the events whose price is equal to or greater than the specified price. |
| To | Enter the date to list the events whose price is equal to or less than the specified price. |
| Category | Enter the category of the event you want to list. For example, Musical event. |
| Location | Enter the location where the event is scheduled to happen. |
| Age | Enter the age of the attendees allowed for the event. |
| Gender | Select the gender of the attendees allowed for the event. |
| Level | Select the level of the attendees to list only those events that match the criteria. |
| Search | Enter a keyword or phrase to list only those events that match the specified criteria. |
| Include | Add the options to include in the event details. For example, attendees, payment. |
| Expand | Add the option you want to expand with detailed information in the event result. |
Attendees¶
Get an Attendee¶
Retrieves details about a specified attendee.
| Attendee ID | Select the Attendee ID whose details you want to retrieve. |
| Include | Add the options to include in the attendee details. For example, attendees, payment. |
| Expand | Add the option you want to expand with detailed information in the attendee's result. |
List Attendees¶
Returns a list of attendees based on the selected attendee.
| Limit | Set the maximum number of attendees Ibexa Connect should return during one scenario execution cycle. |
| Status | Select the status of the attendees you want to list. For example, canceled. |
| From | Enter the date to list the attendees created or updated on or after the specified date. |
| To | Enter the date to list the attendees created or updated on or before the specified date. |
| Event | Select the event whose attendees you want to list. For example, Musical event. |
| Coupon | Enter the coupon details whose applicable attendees you want to list. |
| Search | Enter a keyword or phrase to list only those attendees that match the specified criteria. |
| Include | Add the options to include in the attendee details. For example, Payment. |
| Expand | Add the option you want to expand with detailed information in the attendee's result. |
Other¶
Make an API Call¶
Performs an arbitrary authorized API call.
URL
Enter a path relative to https://api.corsizio.com/. For example: /v1/attendees
Note
For the list of available endpoints, refer to the Corsizio API Documentation.
Method
Select the HTTP method you want to use:
GET to retrieve information for an entry.
POST to create a new entry.
PUT to update/replace an existing entry.
PATCH to make a partial entry update.
DELETE to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - List Attendees¶
The following API call returns all the atendees from your Corsizio account:
URL: /v1/attendees
Method: GET
Matches of the search can be found in the module's Output under Bundle > Body > list. In our example, 7 attendees were returned:
