Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

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

Upload the plugin

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

Install dependencies

Run composer install in the plugin root.
3

Configure environment variables

Set the following environment variables:
VariableDescription
APP_URLThe public URL of the plugin
OMNEO_DOMAINYour Omneo tenant name
OMNEO_TOKENYour Omneo API token
OMNEO_SECRETYour Omneo shared secret
4

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

ScopeWhy needed
create-webhooksCreates the inbound webhook from Zendesk
delete-webhooksRemoves old webhooks during reinstall
read-tenantsReads plugin config from Omneo custom fields
update-tenantsWrites plugin config to Omneo custom fields
update-profilesWrites the Zendesk ID to the Omneo profile
create-interactionsRecords ticket events as Omneo interactions
Sidebar app configuration and supported Zendesk plan requirements are available from your Omneo implementation team.