Setting up the Zendesk plugin

The Omneo Zendesk plugin is a Laravel application hosted on your own infrastructure or a cloud platform.

Upload the plugin

Upload the plugin to a web server with the public directory set to /public.

Install dependencies

Run composer install in the plugin root.

Configure environment variables

Set the following environment variables:

Run the installer

Run php artisan omneo:install and follow the prompts. This sets up the required webhooks and configuration in both Omneo and Zendesk.

Token scopes

Scope	Why needed
`create-webhooks`	Creates the inbound webhook from Zendesk
`delete-webhooks`	Removes old webhooks during reinstall
`read-tenants`	Reads plugin config from Omneo custom fields
`update-tenants`	Writes plugin config to Omneo custom fields
`update-profiles`	Writes the Zendesk ID to the Omneo profile
`create-interactions`	Records ticket events as Omneo interactions

Sidebar app configuration and supported Zendesk plan requirements are available from your Omneo implementation team.

⌘I