Introduction

The EventHQ API is organised around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate API errors. We support cross-origin resource sharing to allow you to interact securely with our API from a client-side web application (though you should remember that you should never expose your secret API key in any public website's client-side code). JSON will be returned in all responses from the API, including errors.

Versioning and API endpoints

When we make backwards incompatible changes to the API we release a new version. The current version is v1. You can construct your API endpoints to either point to a specific version, or to automatically point to the latest version of the API.

Example endpoints, change "your-subdomain" for your actual account subdomain. For example, if your EventHQ account is https://demo.eventhq.co.uk, then you would use "demo" in place of "your-subdomain". Endpoint for a specified version - version 1 in this example:

https://your-subdomain.eventhq.co.uk/api/v1

Endpoint for the latest version of the API

https://your-subdomain.eventhq.co.uk/api

Authentication

You authenticate to the EventHQ API by providing one of your API keys in the request as the "token" param in the URL. Each user within EventHQ has their own API key and we recommend you create a special API user within EventHQ. You can have multiple API keys active at one time.

The API key can be found on the users edit page:

Authentication

We recommend you regenerate the API key from time to time to ensure your account remains secure.

All API requests should be made over HTTPS. Calls made over plain HTTP will be redirected to use an HTTPS alternative. You must authenticate for all requests.

Still need help? Contact Us Contact Us