> ## 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.

# Setting up the Zendesk plugin

> How to install and configure the Omneo Zendesk plugin.

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

<Steps>
  <Step title="Upload the plugin">
    Upload the plugin to a web server with the public directory set to `/public`.
  </Step>

  <Step title="Install dependencies">
    Run `composer install` in the plugin root.
  </Step>

  <Step title="Configure environment variables">
    Set the following environment variables:

    | Variable       | Description                  |
    | -------------- | ---------------------------- |
    | `APP_URL`      | The public URL of the plugin |
    | `OMNEO_DOMAIN` | Your Omneo tenant name       |
    | `OMNEO_TOKEN`  | Your Omneo API token         |
    | `OMNEO_SECRET` | Your Omneo shared secret     |
  </Step>

  <Step title="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.
  </Step>
</Steps>

## 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  |

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