REST API - Overview

This will require a developer within your organisation to consume the API within your organisation and should have a basic understanding of HTTP APIs. EventLyte also provides the ability to consume your organisation’s REST APIs if this is preferred. For more information, please contact a representative.

The API is enabled on all instances of EventLyte CRM to be used to ensure that you can easily move data in and out as required.

Feature Overview

• It provides the ability to allow you to authenticate over TLS 1.2+

• It allows for token-based authentication

• Returns consistent error message body formats and response codes

• Is performant for large volumes of data loads

• Provides Swagger OpenAPI spec documentation for you to browse endpoints easily

• Supports different entity types, with out of the box support for Contacts (used in examples)

Swagger

Dynamically generated Swagger documentation is available on your EventLyte instance. To view the swagger documentation simply navigate to https://your-instance.crm.eventlyte.com/api/swagger to view the available endpoints and request/response body format(s).

For further information about Swagger, in general, refer to: https://swagger.io/docs/specification/v2_0/what-is-swagger/