How can I access the API documentation?

What are APIs?
API stands for Application Programming Interface, which is a software intermediary that allows two applications to talk to each other. This communication can take place between totally different programming languages, ​​in an agile and secure way, because they create a kind of gate, in which only a specific set of information (defined by the company that owns the integration) will be available and sent. In other words, an API is the messenger that delivers your request to the provider that you're requesting it from and then delivers the response back to you. An example of it would be the integration between Facebook and Uber. When registering, many people click on the button Login with Facebook, which is often logged on people's smartphones. The API pulls the Facebook registration information and sends it to Uber, being incredibly convenient for users that don't want to take their time creating filling up another registration form.

How can I access the InEvent API?

There are two ways to access the InEvent API:

  1. By clicking on the API for developers button, located on the right bottom of your screen.
How to access InEvents API
  1. Or at the company level, by clicking on Integrations > API References. When accessing the documentation from this option, it will open in another tab.

Accessing the API and its documentation allows any external system (such as your own website or CRM) to connect directly with the InEvent platform performing updates safely and easily. One of the key advantages of connecting to our API is the great deal of flexibility that it offers.

How can I run an API request?

To create integrations and exchange information in real-time via API, just follow the documentation presented on the platform. Here is a step-by-step guide for it:

  1. Access the API.

  1. Press Search for searching the information you need in the system.

  1. Enter the info command in which you want to find the integration document.

  1. Analyze the requested structure and continue with its development.
API calls involving credit using features, such as adding attendees and sending emails, will use credits from your account balance. Please check this article for more information.

InEvent Developer Guide

Our philosophy is ''If there's no REST documentation for this module, it doesn't exist". That's why since the very beginning of InEvent, every single module has been documented and we have created a Developer Guide to help you integrate with our API.

You can also access our guides from the API Reference by clicking on Developer Guides In the upper left corner.

Accessing the developers guide

In practical terms, what can I do using the API integrations?

When integrating other systems to InEvent through our API end-points, you will be able to perform operations based on retrieving, adding, deleting, or overwriting information from our database, empowering yourself to do things such as:

  • event.person.dismiss: remove an attendee from the event
  • event.person.bind: add an attendee to the event
  • event.person.operate: overwrite a specific field on the attendee's profile
  • event.tool.edit: edits the event information
  • activity.remove: remove an activity from your event
To check the most frequently asked questions about our API, please check this article.

There are hundreds of possible requests, please check the API documentation as shown below or get in touch with our support team for further information.

Please note that direct integrations with our API are available exclusively for Full Plan customers. However, customers with an Advanced plan can still access the API through Zapier. Please check this article for more information.
If you plan to use a CRM platform other than Salesforce or Marketo, we recommend using the InEvent API to perform the integration.

InEvent Partners can help you with your integrations!

If you are looking for someone to help you with the API integrations you need, check out EventMarket, our exclusive marketplace with dozens of certified partners that will help you ensure everything runs smoothly at your event.


How Did We Do?