Introduction

The Revelation helpdesk API is a secure REST API that uses the OAuth 2.0 and the OIDC Connect protocol to protect its endpoints, by providing secure authentication and authorization.

OpenID Connect (OIDC) is an identity authentication protocol built on top of the OAuth 2.0 framework. It standardizes the process of authenticating and authorizing users when they sign in to access digital services like API’s

With OIDC you first retrieve an access token for the API, then use that token to authenticate future requests. Click the links for more information about OAuth 2.0 and OpenID Connect.

Integration with the Revelation helpdesk API is a feature released in Revelation Server 2025 / Revelation Cloud V25, however it is not available in the Revelation Core (free) edition.

The Revelation helpdesk API is a work in progress. The current version of the API is Version 2.0 and represents many endpoints that can be used to create / update and manage Tickets, Clients, Projects and Users in the helpdesk system. Development of the API is ongoing and future releases will expand on the number of endpoints available in the API.

Audience

This article is aimed at developers who already have a basic understanding of OAuth 2.0 concepts and REST API’s.  It will explain how to access the Revelation helpdesk API by retrieving access tokens from the authorization server and how to call the various API endpoints. Non-developers should not proceed further in this section.

Jump to a specific section:

• RESTful Concepts
• Getting Started
• Creating Clients
• Fetching Tokens
• Request Data
• Execute Endpoints in Swagger UI
• Scopes
• Grant Types