Navbar
shell javascript

Introduction

This section contains basic concepts such as Authentication, Authorization and Pagination. Eventtia's API v3 is mostly compliant with the JSON API v1.0 specification.

Authentication via Username and Password

To authenticate, use this code:

# Get your token for further authorization
curl 'https://connect.eventtia.com/api/v3/auth' \
  -X POST \
  -H 'Content-Type: application/json' \
  -d '{"email":"email@example.org", "password":"myPassword"}'
// Get your token for further authorization
fetch('https://connect.eventtia.com/api/v3/auth', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    email: 'email@example.org',
    password: 'myPassword'
  })
})

Example of a successful (200) response:

HTTP/1.1 200 OK
{"auth_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGFzcyI6IlVzZXIiLCJhdXRoZW50aWNhdGlvbl9rZXkiOiJ0ZXN0QGV2ZW50dGlhLmNvbSIsImV2ZW50X3VyaSI6InRlc3QtZXZlbnQiLCJleHAiOjE1MjAzNTY1MDB9.s0m351gn4tuRe4sdF_qw3rTleleWh4TTTt35f1n4lLy"}

Example of a 401 response:

HTTP/1.1 401 Unauthorized
{"message":"Wrong username or password."}

You can get an authorization token for a User with this endpoint. Tokens issued by Eventtia are valid for 30 days.

HTTP Request

POST /api/v3/auth

Query Parameters

Parameter Type Description
email string The User's email.
password string The User's password.

Authorization

When you make a request to any protected endpoint, add the token in the Authorization header

# Send your token in the Authorization header
curl '<api endpoint>' \
  -H 'Authorization: Bearer <your token>' \
  ...
// Send your token in the Authorization header
fetch('<api endpoint>', {
  headers: {
    'Authorization': 'Bearer <your token>',
  },
  ...
})

Make sure you replace <your token> with the JWT you get when you authenticate.

Eventtia uses JSON Web Tokens for authorization. Tokens issued by Eventtia are valid for 30 days.

Pagination

You can request a specific page size and number by sending the page param in the request query params:

curl '<api endpoint>?page[size]=12&page[number]=1'
fetch('<api endpoint>?page[size]=12&page[number]=1')

Example response:

{
  "data": [...],
  "links": {
    "self": "<api endpoint>?page[number]=1&page[size]=12",
    "first": "<api endpoint>?page[number]=1&page[size]=12",
    "prev": null,
    "next": null,
    "last": "<api endpoint>?page[number]=1&page[size]=12"
  },
  "meta": {
    "total_pages": 1
  }
}

All list endpoints are paginated by default. The default page size is 24, and the default page number is 1. The response contains links to the first, previous (prev), current (self), next and last pages. For convenience, a total_pages meta field, which contains the total number of pages given the current query parameters, is included as well.

Included resources

You can request the attributes for related entities by sending the include param in the request query params:

curl '<api endpoint>?include=rel1.nested_rel,rel2'
fetch('<api endpoint>?include=rel1.nested_rel,rel2')

Example response:

{
  "data": [...],
  "included": [
    {"id": "123", "type": "rel1", "attributes": {...}},
    ...
  ]
}

Some endpoints allow you to retrieve the data of related entities. The response contains the included section when you request the data or when other resources are included by default. See each endpoint's description for the list of available additional resources.

Errors

Status Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your token is invalid or not present.
403 Forbidden -- Your token doesn't grant you access to this resurce.
404 Not Found.
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Events

List of Events

curl 'https://connect.eventtia.com/api/v3/events' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint returns the list of events for the User indicated in the JWT.

HTTP Request

GET /api/v3/events

Query Parameters

Parameter Type Description
page json A page object as described here.
updated_since date A datetime in the following format: 2019-12-31T14:25:46.000-05:00, or part of it: 2019-12.
templates boolean Send true if you want to get only template events
template number The id of a specific template to get all the events cloned from it

Create Event

curl 'https://connect.eventtia.com/api/v3/events'
fetch('https://connect.eventtia.com/api/v3/events')

This endpoint allows you to create a new event.

HTTP Request

POST /api/v3/events

Query Parameters

Parameter Type Description
name string Event name.
start_date datetime A datetime in the following format "14/08/2020 - 23:00:00"
end_date datetime A datetime in the following format "14/08/2020 - 23:00:00"
is_virtual boolean True if you event is virtual
default_language string Available options es, en and fr
event_uri string Define a uri for your event website. Please do not use spaces or special characters.
virtual_timezone string The default event timezone
description string Short description of your event
sender_name string Name of the person who will appear in the communications of your event
sender_email string Email from where event communications will be sent
active boolean This value allows you to indicate if your event is active or inactive
custom_fields_data Object field_id: field value eg {"692349"=>"Field value here"}}

Event

curl 'https://connect.eventtia.com/api/v3/events/test-event-1'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1')

This endpoint returns the event associated with the specified event_uri.

HTTP Request

GET /api/v3/events/:event_uri

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event you want to retrieve.

Update Event

curl 'https://connect.eventtia.com/api/v3/events/test-event-1'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1')

This endpoint allows you to update an event for the specified event_uri.

HTTP Request

PUT /api/v3/events/:event_uri

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event you want to update.

Query Parameters

Parameter Type Description
name string Event name.
start_date datetime A datetime in the following format "14/08/2020 - 23:00:00"
end_date datetime A datetime in the following format "14/08/2020 - 23:00:00"
is_virtual boolean True if you event is virtual
default_language string Available options es, en and fr
event_uri string Define a uri for your event website. Please do not use spaces or special characters.
virtual_timezone string The default event timezone
description string Short description of your event
sender_name string Name of the person who will appear in the communications of your event
sender_email string Email from where event communications will be sent
active boolean This value allows you to indicate if your event is active or inactive
custom_fields_data Object field_id: field value eg {"692349"=>"Field value here"}}

Clone Event

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/clone'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/clone')

This endpoint allows you to clone the event associated with the specified event_uri.

HTTP Request

POST /api/v3/events/:event_uri/clone

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event you want to clone.

Query Parameters

Parameter Type Description
clone_zones boolean True if you want to clone the event zones.
clone_speakers boolean True if you want to clone the event speakers
clone_workshops boolean True if you want to clone the event workshops
clone_pois boolean True if you want to clone the event speakers
clone_attendee_types boolean True if you want to clone the event attendee types
clone_business_conference boolean True if you want to clone the event business conferences
clone_event_page boolean True if you want to clone the event page

Event Clone Progress

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/clone-progress'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/clone-progress')

This endpoint return the clone progress for the specified event event_uri.

HTTP Request

GET /api/v3/events/:event_uri/clone-progress

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event.

Custom Fields

curl 'https://connect.eventtia.com/api/v3/event-custom-fields'
fetch('https://connect.eventtia.com/api/v3/event-custom-fields')

This endpoint returns the custom fields available for creating an event.

HTTP Request

GET /api/v3/event-custom-fields

Path Parameters

Parameter Type Description
page json A page object as described here.

Event Files

List of Files in a Category

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/event_file_categories/1/event_files' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/event_file_categories/1/event_files', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint returns the list of event files associated with the corresponding event and category.

HTTP Request

GET /api/v3/events/:event_uri/event_file_categories/:event_file_category_id/event_files

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the event file category.
event_file_category_id number The ID of the event file category you want to retrieve.

Query Parameters

Parameter Type Description
page json A page object as described here.

Uploading a File

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/event_file_categories/1/event_files' \
  -X POST \
  -H 'Authorization: Bearer <your token>' \
  -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary50m3NumB3r' \
  -F 'event_file[name]=name' \
  -F 'event_file[description]=description' \
  -F 'event_file[event_file]=@/path/to/file.pdf'
const file = document.getElementById('input-id').files[0]; // 'input-id' here should be the id of the file input in your HTML
const data = new FormData();
data.append('event_file[name]', 'name');
data.append('event_file[description]', 'optional description');
data.append('event_file[event_file]', file, file.name);

fetch('https://connect.eventtia.com/api/v3/events/test-event-1/event_file_categories/1/event_files', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your token>',
  },
  body: data
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint uploads a file in the corresponding category.

HTTP Request

POST /api/v3/events/:event_uri/event_file_categories/:event_file_category_id/event_files

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the event file category.
event_file_category_id number The ID of the event file category in which the file will be found once uploaded.

Body Parameters

Parameter Type Optional Description
event_file[name] string false The name of the file.
event_file[description] string true Description of the file.
event_file[event_file] file false The file to upload.

Business Conferences

List of Business Conferences

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint returns the list of business conferences for an event along with their participant types.

HTTP Request

GET /api/v3/events/:event_uri/business_conferences

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the business conference.

Query Parameters

Parameter Type Description
page json A page object as described here.
updated_since date A datetime in the following format: 2019-12-31T14:25:46.000-05:00, or part of it: 2019-12.

List of Business Conference Participant Types

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types')

This endpoint returns the list of participant types for a business conference, along with the associated attendee types and the custom fields for both the participant types and the attendee types.

HTTP Request

GET /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_participant_types

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the business conference.
business_conference_id string The ID of the business conference.

Query Parameters

Parameter Type Description
page json A page object as described here.

List of Business Conference Participant Type Unavailable Hours

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours')

This endpoint returns the list of unavailable hours for a business conference participant type.

HTTP Request

GET /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_participant_types/:business_conference_participant_type_id/unavailable_hours

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the business conference.
business_conference_id Integer The ID of the business conference.
business_conference_participant_type_id Integer The ID of the business conference participant type.

Query Parameters

Parameter Type Description
page json A page object as described here.

Create Business Conference Participant Type Unavailable Hour

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours')

This endpoint allows you to create a new unavailable hour for a business conference participant type

HTTP Request

POST /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_participant_types/:business_conference_participant_type_id/unavailable_hours

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the business conference.
business_conference_id Integer The ID of the business conference.
business_conference_participant_type_id Integer The ID of the business conference participant type.

Query Parameters

Parameter Type Description
start_date datetime Restriction start date. Eg. 10/12/2020 - 01:00
end_date datetime Restriction end date. Eg. 10/12/2020 - 01:00

Update Business Conference Participant Type Unavailable Hour

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours/1'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours/1')

This endpoint allows you to update a unavailable hour for a business conference participant type

HTTP Request

PUT /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_participant_types/:business_conference_participant_type_id/unavailable_hours/:id

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the business conference.
business_conference_id Integer The ID of the business conference.
business_conference_participant_type_id Integer The ID of the business conference participant type.
id Integer The ID of the business conference participant type unavailable hour.

Query Parameters

Parameter Type Description
start_date datetime Restriction start date. Eg. 10/12/2020 - 01:00
end_date datetime Restriction end date. Eg. 10/12/2020 - 01:00

Destroy Business Conference Participant Type Unavailable Hour

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours/1'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours/1')

This endpoint allows you to destroy a unavailable hour for a business conference participant type

HTTP Request

DELETE /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_participant_types/:business_conference_participant_type_id/unavailable_hours/:id

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the business conference.
business_conference_id Integer The ID of the business conference.
business_conference_participant_type_id Integer The ID of the business conference participant type.
id Integer The ID of the business conference participant type unavailable hour.

List of Participants

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participants?participant_type_id=13' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participants?participant_type_id=13', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint returns the list of participants for a business conference, possibly filtered by type. It also returns the business_conference_profile_fields, attendees and attendee_type_custom_fields. Each participant has one attendee and zero or more business conference profile fields, which describe the participant's profile extra fields (name of the field, possible values, etc.). Each attendee has a set of attendee type custom fields, which include six default fields (first_name, last_name, email, company, telephone, city_id) and zero or more non-default fields listed under the attendee's custom_fields attribute.

HTTP Request

GET /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_participants

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the business conference.
business_conference_id number The ID of the desired business conference.

Query Parameters

Parameter Type Optional Description
page json true A page object as described here.
participant_type_id number true The ID of the type you want to use to filter the participants.
updated_since date A datetime in the following format: 2019-12-31T14:25:46.000-05:00, or part of it: 2019-12.

Participant Agenda

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participants/456/agenda' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participants/456/agenda', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint returns the list of meetings for a participant and the data for all participants involved in the meetings (for more info on the participant attributes listed here, take a look at the List of Participants endpoint). In addition, the meta information section includes a list of slots for the participant type (agenda) and a list of slots in which the participant won't be available (blocked_slots).

The agenda is an object in which the keys are the UNIX Epoch time for the slot's start date, and the values are arrays with the start and end dates for each slot. The blocked_slots are an array of agenda keys.

HTTP Request

GET /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_participants/:participant_id/agenda

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the business conference.
business_conference_id number The ID of the associated business conference.
participant_id number The ID of the desired participant.

Query Parameters

Parameter Type Optional Description
page json true A page object as described here.

Meetings in a Business Conference

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_meetings' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_meetings', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint returns the list of meetings for a business conference along with the associated participants (for more info on the participant attributes listed here, take a look at the List of Participants endpoint).

HTTP Request

GET /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_meetings

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the business conference.
business_conference_id number The ID of the desired business conference.

Query Parameters

Parameter Type Optional Description
page json true A page object as described here.

For more info on the possible values for a meeting's status or source, take a look at the Participant Agenda endpoint.

Attendee Types

List of Attendee Types

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendee_types' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendee_types', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint returns the list of attendee types for an event along with their custom fields.

HTTP Request

GET /api/v3/events/:event_uri/attendee_types

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
page json A page object as described here.
include string A list of included resources as described here. The attendee_type_custom_fields are included by default.

Attendees

List of Attendees

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint returns the list of attendees for an event along with their attendee type (attendee_type) and custom field details (attendee_type_custom_fields), if requested via the include param. Authorization in this endpoint is optional; if you don't send an Authorization header, the response will only contain custom fields marked as available in public listings.

HTTP Request

GET /api/v3/events/:event_uri/attendees

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
page json A page object as described here.
include string A list of included resources as described here.
include_rejected boolean If set to true, rejected participants will be listed as well.
include_archived boolean If set to true, deleted and rejected participants will be listed as well.
only_confirmed boolean If set to true, only confirmed participants will be listed.
first_name string Filters results by the attendee's first name.
last_name string Filters results by the attendee's last name.
email string Filters results by the attendee's email.
company string Filters results by the attendee's company.
created_date_time datetime Filters the information of the attendees created after the given datetime 2021-10-31T14:25:46).
updated_date_time datetime Filters the information of the attendees updated after the given datetime(2021-10-31T14:25:46).

Create Attendee

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees/register' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees/register', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint allows you to create a new attendee.

HTTP Request

POST /api/v3/events/:event_uri/attendees/register

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
api_key string Event api key to which you want to register the attendee
attendee_type_id integer Id of the attendee type
first_name string Attendee name
last_name string Attendee last name
email string Attendee email
company string Attendee company name
telephone string Attendee phone or cellphone with the country code eg +570000000000
job_title string Attendee job title
alternative_email string Attendee alternative email
birthdate date Attendee birthdate eg 27/08/2020
timezone string Timezone of the attendee.
event_id integer Id of the event to which you want to register the attendee
country_id integer Attendee country id
region_id integer Attendee region name
city_id integer Attendee city id
custom_fields Object field_id: field value eg {"692349"=>"Field value here"}}
workshops Object workshop_id: workshop_id Eg {"103625": 103625}`
purchase_items Object purchase_item_id: quantity Eg {"701": 0}
group_registration_uuid string Add the attendee for a existing group identify with that uuid

This is an example of how your request should look:

{"api_key": "your event api key", attendee": {"attendee_type_id": 55428, "first_name": "", "last_name": "", "email": "", "company": "", "telephone": "", "job_title": "", "alternative_email": "", "birthdate": "27/08/2020", "timezone": "", "custom_fields": {"692349"=>""}}, "event_id": 333, "country_id": 2, "region_id": 3, "city_id": 3,"workshops": {"103625": 103625}, "purchase_items": {"701": 2}}

Group Registration

When you register an atteendee, if the participant type of the atteendee has enabled group registration, in the register response you get a new key "meta" that contains an object with a key named "group_uuid", the profiles that you can add to the group and the available seats for each one.

"meta": { "group_uuid": "a061f3", "profiles": { "69031": { "seats": 3, "available": 3 }, "69032": { "seats": 3, "available": 3 } } }

Then, in the next requests for group registration you must send the "group_uuid" value in the the value of "group_registration_uuid" key.

Attendee

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees/123'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees/123')

This endpoint returns the data of the specified attendee along with their attendee type (attendee_type) and custom field details (attendee_type_custom_fields), if requested via the include param.

HTTP Request

GET /api/v3/events/:event_uri/attendees/:attendee_id

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.
attendee_id string The id for the desired attendee.

Query Parameters

Parameter Type Description
include string A list of included resources as described here.

Attendee by email

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees/by_email'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees/by_email')

This endpoint returns the data of the specified attendee along with their attendee type (attendee_type) and custom field details (attendee_type_custom_fields), if requested via the include param.

HTTP Request

GET /api/v3/events/:event_uri/attendees/by_email

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
include string A list of included resources as described here.
email string The email for the desired attendee.

Attendee Activities

List of Activities for an Attendee

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees/123/workshops' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees/123/workshops', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint returns the list of activities in which a given attendee is registered, along with their categories (workshop_categories) and speakers, if requested via the include param.

HTTP Request

GET /api/v3/events/:event_uri/attendees/:attendee_id/workshops

Path Parameters

Parameter Type Description
event_uri string The event_uri for the associated event.
attendee_id string The ID of the associated attendee.

Query Parameters

Parameter Type Description
page json A page object as described here.
include string A list of included resources as described here.

Registering an Attendee to an Activity

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendee_workshops' \
  -X POST \
  -H 'Authorization: Bearer <your token>' \
  -H 'Content-Type: application/json' \
  -d '{"workshop_id":1,"attendee_id":1}'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendee_workshops', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    workshop_id: 1,
    attendee_id: 1
  })
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint allows you to register an attendee to a certain activity from the specified event.

HTTP Request

POST /api/v3/events/:event_uri/attendee_workshops

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Body Parameters

Parameter Type Optional Description
workshop_id integer false The ID from the activity to which the specified attendee will be registered.
attendee_id integer false The ID from the attendee which will be registered to the specified activity.

Unregistering an Attendee from an Activity

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendee_workshops' \
  -X DELETE \
  -H 'Authorization: Bearer <your token>' \
  -H 'Content-Type: application/json' \
  -d '{"workshop_id":1,"attendee_id":1}'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendee_workshops', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer <your token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    workshop_id: 1,
    attendee_id: 1
  })
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint allows you to unregister an attendee from a certain activity from the specified event.

HTTP Request

DELETE /api/v3/events/:event_uri/attendee_workshops

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Body Parameters

Parameter Type Optional Description
workshop_id integer false The ID from the activity from which the specified attendee will be unregistered.
attendee_id integer false The ID from the attendee which will be unregistered from the specified activity.

Updating Activities for an Attendee

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees/1/update_activities' \
  -X DELETE \
  -H 'Authorization: Bearer <your token>' \
  -H 'Content-Type: application/json' \
  -d '{"workshop_id":1,"attendee_id":1}'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees/1/update_activities', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer <your token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    workshop_id: 1,
    attendee_id: 1
  })
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint allows you to register a participant to specific activities and delete their registration to activities that are not specified.

HTTP Request

PUT /api/v3/events/:event_uri/attendees/:attendee_id/update_activities

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.
attendee_id string The ID from the attendee.

Body Parameters

Parameter Type Optional Description
workshop_ids String false List of activity IDs separated by commas in which the participant must remain registered. If the participant is registered to other activities that are not provided in the list of workshop ids, they will be deleted.

Guests

List of Guests

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/guests' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/guests', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint returns the list of guests for an event along with their associated attendee and attendee type, if requested via the include param.

HTTP Request

GET /api/v3/events/:event_uri/guests

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
page json A page object as described here.
include string A list of included resources as described here.

Create Guest

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/guests' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/guests', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint allows you to create a new Guest.

HTTP Request

POST /api/v3/events/:event_uri/guests

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
first_name string Guest name
last_name string Guest last name
email string Guest email
company string Guest company
attendee_type_id integer Set this if you want to restrict the attendee type this guest can choose when they register

Guest

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/guests/123' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/guests/123', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint returns the data of the specified guest along with their associated attendee and attendee type, if requested via the include param.

HTTP Request

GET /api/v3/events/:event_uri/guests/:guest_id

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.
guest_id string The id for the desired guest.

Query Parameters

Parameter Type Description
include string A list of included resources as described here.

Activities

List of Activities

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/workshops' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/workshops', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint returns the list of activities for an event along with their categories (workshop_categories) and speakers, if requested via the include param.

HTTP Request

GET /api/v3/events/:event_uri/workshops

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
page json A page object as described here.
include string A list of included resources as described here.

Activity

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/workshops/115421' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/workshops/115421', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint returns the activity associated with the specified id.

HTTP Request

GET /api/v3/events/:event_uri/workshops/:id

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event for the activity you want to retrieve.
id string The id for the activity you want to retrieve.

Create Activity

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/workshops' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/workshops', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint allows you to create a new activity.

HTTP Request

POST /api/v3/events/:event_uri/workshops

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Activity default parameters

Parameter Type Description
name string Workshop name.
description string Workshop description.
start_date datetime A datetime in the following format "14/08/2020 - 23:00:00".
end_date datetime A datetime in the following format "14/08/2020 - 23:00:00".
location string Workshop location
show_on_register boolean Allow registration for this workshop
allow_blocking_workshops boolean Allow registration for this workshop
availability number
show_for_attendee_type Object attendee_type_id: "true" eg. {"69031": "true"}
price Object attendee_type_id: price eg. {"69031": 200}

Virtual activity parameters

Parameter Type Description
streaming_type string Allowed values 'google_meet', 'webex', 'microsoft_teams', 'youtube', 'other', 'jitsi', 'jitsi_oficial', 'daily_co'
streaming_embed_code Object eg {display_name : 'Test', embed_code:'<div>' } if streaming_type is in 'youtube', 'jitsi' or' other'
streaming_url string Streaming url like 'https://test.streaming.com' if streaming type is other than 'youtube', 'jitsi' or' other'
enable_chat boolean Allow chat on virtual stage
chat_name string Change chat name, default it is 'Chat'
enabled_emotions boolean Allow emotions on virtual stage
interactivity_type string Allowed values mentimeter, slido, sparkup, other_interactivity:
interactivity_snippet string Interactivity snipped as string
translation_snippet string Translation snipped as string

Update Activity

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/workshops/115421' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/workshops/115421', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint allows you to update an activity.

HTTP Request

POST /api/v3/events/:event_uri/workshops/:id

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.
id string The id for the activity you want to retrieve.

Query Parameters

Activity default parameters

Parameter Type Description
name string Workshop name.
description string Workshop description.
start_date datetime A datetime in the following format "14/08/2020 - 23:00:00".
end_date datetime A datetime in the following format "14/08/2020 - 23:00:00".
location string Workshop location
show_on_register boolean Allow registration for this workshop
allow_blocking_workshops boolean Allow registration for this workshop
availability number
show_for_attendee_type Object attendee_type_id: "true" eg. {"69031": "true"}
price Object attendee_type_id: price eg. {"69031": 200}

Virtual activity parameters

Parameter Type Description
streaming_type string Allowed values 'google_meet', 'webex', 'microsoft_teams', 'youtube', 'other', 'jitsi', 'jitsi_oficial', 'daily_co'
streaming_embed_code Object eg {display_name : 'Test', embed_code:'<div>' } if streaming_type is in 'youtube', 'jitsi' or' other'
streaming_url string Streaming url like 'https://test.streaming.com' if streaming type is other than 'youtube', 'jitsi' or' other'
enable_chat boolean Allow chat on virtual stage
chat_name string Change chat name, default it is 'Chat'
enabled_emotions boolean Allow emotions on virtual stage
interactivity_type string Allowed values mentimeter, slido, sparkup, other_interactivity:
interactivity_snippet string Interactivity snipped as string
translation_snippet string Translation snipped as string

List of Attendees in an Activity

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/workshops/123/attendees' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/workshops/123/attendees', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint returns the list of attendees for an activity. For more details regarding the information returned and additional query params, see the attendees endpoint.

HTTP Request

GET /api/v3/events/:event_uri/workshops/:workshop_id/attendees

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event in which the activity occurs.
workshop_id string The id of the desired activity.

Query Parameters

Parameter Type Description
page json A page object as described here.

Categories

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/workshop_categories' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/workshop_categories', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint returns the list of categories (workshop_categories) for an event available to assign to any activity.

HTTP Request

`GET /api/v3/events/:event_uri/workshop_categories

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
page json A page object as described here.

Add Categories to Activity

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/workshops/115421/set-categories' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/workshops/115421/set-categories', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint allows you to assign categories to selected activity.

HTTP Request

POST /api/v3/events/:event_uri/workshops/:id/set-categories

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event in which the activity occurs.
workshop_id string The id of the desired activity.

Query Parameters

Activity default parameters

Parameter Type Description
categories string ids of categories to assign for selected workshop separated by commas.

Speakers

List of Speakers

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/speakers'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/speakers')

This endpoint returns the list of speakers for an event along with their activities (workshops) and activities' categories (workshop_categories), if requested via the include param.

HTTP Request

GET /api/v3/events/:event_uri/speakers

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
page json A page object as described here.
include string A list of included resources as described here.

Merchandising

List of Purchase Items

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/purchase_items' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/purchase_items', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint returns the list of purchase items associated with the corresponding event.

HTTP Request

GET /api/v3/events/:event_uri/purchase_items

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the purchase items.

Query Parameters

Parameter Type Description
page json A page object as described here.

Purchase Item

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/purchase_items/432' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/purchase_items/432', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint returns the details of a purchase item.

HTTP Request

GET /api/v3/events/:event_uri/purchase_items/:purchase_item_id

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the purchase items.
purchase_item_id string The ID of the requested item.

List of Attendee Purchase Items

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees/45/attendee_purchase_items' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees/45/attendee_purchase_items', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint returns the list of purchases for a given attendee, along with attendee (attendee) and purchase item details (purchase_item), if requested via the include param.

HTTP Request

GET /api/v3/events/:event_uri/attendees/:attendee_id/attendee_purchase_items

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the purchase item and the attendees.
attendee_id string The ID of the attendee that purchased these items.

Query Parameters

Parameter Type Description
page json A page object as described here.
include string A list of included resources as described here.

List of Attendee Purchase Items by Event

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendee_purchase_items' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendee_purchase_items', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint returns the list of attendee purchases for a given event, along with attendee (attendee) and purchase item details (purchase_item), if requested via the include param.

HTTP Request

GET /api/v3/events/:event_uri/attendees/:attendee_id/attendee_purchase_items

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event associated with the purchase item and the attendees.

Query Parameters

Parameter Type Description
page json A page object as described here.
include string A list of included resources as described here.

Stands

List of Stand Categories

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/stand_categories'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/stand_categories')

This endpoint returns the list of stand categories for an event.

HTTP Request

GET /api/v3/events/:event_uri/stand_categories

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
page json A page object as described here.

List of Stand Zones

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/zones'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/zones')

This endpoint returns the list of stand zones for an event.

HTTP Request

GET /api/v3/events/:event_uri/zones

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
page json A page object as described here.

List of Stand Reservations

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/stand_reservations'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/stand_reservations')

This endpoint returns the list of public stand reservations for an event.

HTTP Request

GET /api/v3/events/:event_uri/stand_reservations

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
page json A page object as described here.
company_name string The name of a company to filter the list.
zone string The ID of a zone to filter the list.
category string The ID of a category to filter the list.

List of Exhibitor Leads

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/stand_reservations/567/leads' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/stand_reservations/567/leads', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint returns the list of leads for an exhibitor that has a stand reservation.

HTTP Request

GET /api/v3/events/:event_uri/stand_reservations/:stand_reservation_id/leads

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.
stand_reservation_id number The id of the exhibitor's stand reservation.

Query Parameters

Parameter Type Description
page json A page object as described here.

Points of Interest

List of Points of Interest

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/pois'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/pois')

This endpoint returns the list of points of interest for an event.

HTTP Request

GET /api/v3/events/:event_uri/pois

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
page json A page object as described here.

Q&A Sessions

List of Q&A Sessions

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/event_qa_sessions'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/event_qa_sessions')

This endpoint returns the list of Q&A sessions for an event.

HTTP Request

GET /api/v3/events/:event_uri/event_qa_sessions

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
page json A page object as described here.
include string A list of included resources as described here.

Event Params

Event Param

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/event_params/pay_u_api_key' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/event_params/pay_u_api_key', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint returns the requested event param for an event.

HTTP Request

GET /api/v3/events/:event_uri/event_params/:param_name

Path Parameters

Parameter Type Description
event_uri string The event_uri for the associated event.
param_name string The name of the desired event param.

Updating an Event Param

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/event_params/aux_json_data' \
  -X PATCH \
  -H 'Authorization: Bearer <your token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "param_value": [{
        "attr": "val",
        "attr2": "val2"
    }]
}'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/event_params/aux_json_data', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <your token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    param_value: [{
      attr: 'val',
      attr2: 'val2'
    }]
  })
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint allows you to create or modify an event param.

Currently, the only params available for edition are the following:

Param name Param value format
aux_json_data JSON

HTTP Request

PATCH /api/v3/events/:event_uri/event_params/:param_name

Path Parameters

Parameter Type Description
event_uri string The event_uri for the associated event.
param_name string The name of the desired event param.

Body Parameters

Parameter Type Description
param_value any The content stored in the event param. The type depends on the specific param (see the supported names and formats above).

Communications

List of Event Massive Messages

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/massive_messages' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/massive_messages', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint returns the list of massive messages for an event.

HTTP Request

GET /api/v3/events/:event_uri/massive_messages

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
page json A page object as described here.

Event Massive Message Stats

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/massive_messages/1/stats' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/massive_messages/1/stats', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint returns the stats for a massive message.

HTTP Request

GET /api/v3/events/:event_uri/massive_messages/:id/stats

Path Parameters

Parameter Type Description
event_uri string The event_uri for the massive message event.
id integer The id for the desired massive message.

Countries, Regions and Cities

List of Countries

curl 'https://connect.eventtia.com/api/v3/countries'
fetch('https://connect.eventtia.com/api/v3/countries')

This endpoint returns the list of all countries.

HTTP Request

GET /api/v3/countries

Query Parameters

Parameter Type Description
page json A page object as described here.

List of Regions

curl 'https://connect.eventtia.com/api/v3/countries/51/regions'
fetch('https://connect.eventtia.com/api/v3/countries/51/regions')

This endpoint returns the list of all regions for a given country.

HTTP Request

GET /api/v3/countries/:country_id/regions

Path Parameters

Parameter Type Description
country_id number The ID of the desired country.

Query Parameters

Parameter Type Description
page json A page object as described here.

List of Cities

curl 'https://connect.eventtia.com/api/v3/countries/51/regions/722/cities'
fetch('https://connect.eventtia.com/api/v3/countries/51/regions/722/cities')

This endpoint returns the list of all cities for a given region.

HTTP Request

GET /api/v3/countries/:country_id/regions/:region_id/cities

Path Parameters

Parameter Type Description
country_id number The ID of the desired country.
region_id number The ID of the desired region.

Query Parameters

Parameter Type Description
page json A page object as described here.

City

curl 'https://connect.eventtia.com/api/v3/cities/7993'
fetch('https://connect.eventtia.com/api/v3/cities/7993')

This endpoint returns a city along with its region and country.

HTTP Request

GET /api/v3/cities/:city_id

Path Parameters

Parameter Type Description
city_id number The ID of the desired city.

Web Hooks

List Account Web Hooks

curl 'https://connect.eventtia.com/en/api/v3/web_hooks' \
  -X GET \
  -H 'Authorization: Bearer <your token>' \
  -H 'Content-Type: application/json' \
fetch('https://connect.eventtia.com/en/api/v3/web_hooks', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your token>',
    'Content-Type': 'application/json',
  },
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint allows you to list all created webhooks for your account. If you want to obtain the list of webhooks created for a specific event, you could do it by sending an extra parameter called event_uri with the URI of the desired event.

HTTP Request

GET /api/v3/web_hooks

Body Parameters

Parameter Type Description
event_uri string The event_uri for certain event.

Creating a Event Web Hook

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/event_web_hooks' \
  -X POST \
  -H 'Authorization: Bearer <your token>' \
  -H 'Content-Type: application/json' \
  -d '{"target_url":"https://mydomain.com/web-hooks/eventtia/uuid-for-attendee-created", "trigger":"attendee_created"}'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/event_web_hooks', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    target_url: 'https://mydomain.com/web-hooks/eventtia/uuid-for-attendee-created',
    trigger: 'attendee_created'
  })
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint allows you to subscribe to certain events. Once subscribed, you will receive a POST request to the specified URL every time the triggering event happens.

HTTP Request

POST /api/v3/events/:event_uri/event_web_hooks

Path Parameters

Parameter Type Description
event_uri string The event_uri for the associated event.

Body Parameters

Parameter Type Optional Description
target_url string false The URL to which the resource will be sent. This URL must be unique, and it must contain all the information needed to validate that the request comes from Eventtia.
trigger string false One of the triggers listed below.

Available Web Hook Triggers

Deleting a Event Web Hook

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/event_web_hooks' \
  -X DELETE \
  -H 'Authorization: Bearer <your token>' \
  -H 'Content-Type: application/json' \
  -d '{"target_url":"https://mydomain.com/web-hooks/eventtia/uuid-for-attendee-created"}'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/event_web_hooks', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer <your token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    target_url: 'https://mydomain.com/web-hooks/eventtia/uuid-for-attendee-created'
  })
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint deletes the subscription associated with the target URL.

HTTP Request

DELETE /api/v3/events/:event_uri/event_web_hooks

Path Parameters

Parameter Type Description
event_uri string The event_uri for the associated event.

Body Parameters

Parameter Type Optional Description
target_url string false The URL you used to subscribe to a certain trigger.
trigger string false One of the available triggers

Creating a Account Web Hook

curl 'https://connect.eventtia.com/api/v3/accounts/account-api-key/web_hooks' \
  -X POST \
  -H 'Authorization: Bearer <your token>' \
  -H 'Content-Type: application/json' \
  -d '{"target_url":"https://mydomain.com/web-hooks/eventtia/uuid-for-attendee-created", "trigger":"attendee_created"}'
fetch('https://connect.eventtia.com/api/v3/accounts/account-api-key/web_hooks', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    target_url: 'https://mydomain.com/web-hooks/eventtia/uuid-for-attendee-created',
    trigger: 'attendee_created'
  })
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint allows you to subscribe to certain events. Once subscribed, you will receive a POST request to the specified URL every time the triggering event happens.

HTTP Request

POST /api/v3/accounts/:account_api_key/web_hooks

Path Parameters

Parameter Type Description
account_api_key string Your account_api_key.

Body Parameters

Parameter Type Optional Description
target_url string false The URL to which the resource will be sent. This URL must be unique, and it must contain all the information needed to validate that the request comes from Eventtia.
trigger string false One of the triggers listed below.

Available Web Hook Triggers

Deleting a Account Web Hook

curl 'https://connect.eventtia.com/api/v3/accounts/account-api-key/web_hooks' \
  -X DELETE \
  -H 'Authorization: Bearer <your token>' \
  -H 'Content-Type: application/json' \
  -d '{"target_url":"https://mydomain.com/web-hooks/eventtia/uuid-for-attendee-created"}'
fetch('https://connect.eventtia.com/api/v3/accounts/account-api-key/web_hooks', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer <your token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    target_url: 'https://mydomain.com/web-hooks/eventtia/uuid-for-attendee-created'
  })
})

Make sure you replace <your token> with the JWT you get when you authenticate.

This endpoint deletes the subscription associated with the target URL.

HTTP Request

DELETE /api/v3/accounts/:account_api_key/web_hooks

Path Parameters

Parameter Type Description
account_api_key string Your account_api_key.

Body Parameters

Parameter Type Optional Description
target_url string false The URL you used to subscribe to a certain trigger.
trigger string false One of the available triggers

Surveys

List of Surveys

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/surveys'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/surveys')

This endpoint returns the list of surveys for an event.

HTTP Request

GET /api/v3/events/:event_uri/surveys

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
page json A page object as described here.
include string A list of included resources as described here.

Add survey answer

curl 'https://connect.eventtia.com/api/v3/events/:event_uri/surveys/:id/answers' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/:event_uri/surveys/:id/answers', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint allows you add an response for the specified survey

HTTP Request

POST /api/v3/events/:event_uri/surveys/:id/answers

Path Parameters

Parameter Type Description
event_uri string The event_uri for the event..
survey_id integer The id of the desired survey.

Query Parameters

Parameter Type Description
answers json The survey answers in JSON format with the following schema: {"question_id": "Question answer"}
survey_type string Allowed values, 'attendee' and 'business_conference_meetings'

List of Survey Answers

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/surveys/:survey_id/survey_answers' \
  -H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/surveys/:survey_id/survey_answers', {
  headers: {
    'Authorization': 'Bearer <your token>',
  }
})

This endpoint returns the list of answers for a survey.

HTTP Request

GET /api/v3/events/test-event-1/surveys/:survey_id/survey_answers

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.
survey_id integer The survey_id for the desired survey

Query Parameters

Parameter Type Description
page json A page object as described here.

Payments

List of Attendee Payments

curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendee-payments'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendee-payments')

This endpoint returns the list of attendee payments for an event.

HTTP Request

GET /api/v3/events/:event_uri/attendee-payments

Path Parameters

Parameter Type Description
event_uri string The event_uri for the desired event.

Query Parameters

Parameter Type Description
page json A page object as described here.
include string A list of included resources as described here.
start_date_time datetime Start date time filter eg 2020-07-16 23:00
end_date_time datetime End date time filter eg 2020-07-30 23:00
payment_type integer Payment type filter. Supported options manual_payment: 1 , electronic: 3
status string Filter payments by status. Receives a comma-separated list. Suppported options processing, accepted, refuted, expired, error, refunded