Setting Up Integrations (APIs)

OpenEnvoy provides a self-serve API to easily integrate your systems

At a high-level, there are three different levels of integrations which SaaS companies offer:

  1. Export - This is the most basic way for enterprise users to access the raw data they need so that they can analyze it on their own, import it into another tool, or ease concerns around vendor lock-in. Exporting data can be self-service (where the user presses a button in your application) or manual (where the user emails your support staff for them to retrieve and provide the data).
  2. API - Providing a publicly accessible endpoint for any end-user to query and retrieve data allows for further flexibility. Many enterprises have complex needs and oftentimes leverage SaaS tools within a specific workflow. An easy access API is valuable in that enterprises can build their own solutions with the data in your service.

    API access is also important if your service benefits from receiving data from other services. Making it as easy as possible for end-users to get the most value out of your service is critical.

  3. Webhook notification - Webhooks are similar to an API in that they can be easily incorporated into other workflows. However, these notifications typically reflect the important events in your application, e.g. something stopped working, or data is no longer being sent. While in-app notifications are great, providing those same notifications via outbound webhooks allows users to integrate your service into their collaboration tools such as Slack.

View OpenEnvoy's API documentation.

Generate an API key

System Administrators can generate an API key directly from the Workspace! This unique feature allows our customers to take advantage of our flexible integration method and maintain full control over two-way system integrations for pushing or pulling data out or pushing data into OpenEnvoy. 

To get started, click Workspace, and navigate to the Integrations tab. At the bottom of the Integrations page, go to the OpenEnvoy API section, and click the Generate API key button.

Once the Generate API key button has been clicked, the API key has been generated, and a timestamp will appear. When the API is active, the timestamp will show when the API was last used.

Click copy, and a confirmation message will appear showing the API key has been copied to your clipboard.

By default and for security purposes, the API key is always hidden. To disable the eye lock, click the eye lock icon to view the API key.

To deactivate the API key, click the Deactivate button. A confirmation message will appear, click Yes, deactivate key

If the key is deactivated, you may generate a new API key and the timestamp will reset.

We recommend generating a new API key every 90 days for added security.


Have questions? Please contact the Customer Success team or email