This article describes the integration with the Zapier application. The Zapier application simplifies business process automation by connecting various online tools through straightforward automations, eliminating the need for programming. This document provides integration details, including the design itself, a description of the implementation of the 360dialog application within the Zapier platform, and useful links for further improvements.

The implementation of the 360dialog Zapier application utilizes the Zapier Platform CLI. The Zapier CLI is a tool for developing and managing Zapier applications directly from the command line. The CLI supports version control system integration, provides testing tools, and allows straightforward implementation on the Zapier platform after development and testing completion. The integration is associated with the Insights API, specifically the external-events endpoint.

Link to 360dialog dev Zapier App (currently private): https://zapier.com/app/connections/private/[email protected]

The endpoint is stored as an environment variable on the Zapier platform, currently set to target the staging Insights API. Also, all environment variables are tied to the application version. The version of the 360dialog application at the time of writing this article is 1.0.0.

Zapier provides predefined methods for setting up authentication (Basic, OAuth, Custom, etc.). As we opted for external users to use an API Key for authentication to the Insights API, the Zapier custom method was utilized. In the initial version of this application, users will be prompted to enter both the API Key and Client ID. After an improvement on the backend, only entering the API Key will be required.

Below is the initial Zapier dialog presented to the user during Sign In:

The data sent within the body to the external-events endpoint consists of fields on the Zapier platform. Fields can be required or optional, depending on how they are defined on the API side. Descriptions of all fields are suggestions from the Product side.

Note: Not all templates are always 100% accurate; they are intended only as guidelines, so exercise caution when copying completed solutions into your code.