The Eventsforce API allows external applications to query and manipulate data that is stored in Eventsforce. For this to work, you need to create an API role and provide an API key. The API key is a secret password that allows users to access data in your Eventsforce account.

For information on what's included in the API you can read our API documentation for developers.

This article covers the following:

The first step is to create an API role that will then be assigned to a standalone user. Follow the steps below:

We recommend starting with the minimum access required, this usually includes the "read" functions, as then changes cannot be pushed back into Eventsforce:

If you will be using the API with many events, make sure the user has access to the events they will be pulling data from.

If you require your applications to update Eventsforce for example, attendance recording using EF Attendance, you will also need to add the following functions: 

The next step is to assign the API role to a standalone user. If the user does not exist, add a new user before going forward. Once created, take the below steps:

Note: The API role should not be assigned to other active users with other roles. The API is a standalone role.

The final step is to generate an API key. This is a secret password that the API will use to access data in your events. To create the key:

A new key will be generated that looks something like this:

C82749F75A044C5A9A6B6BF125B1F479

This key must be kept secret, treat it like a password. 

You will be required to add the API key to the other application you are working with such as EF Attendance.