To install the app you must have an iframe that is accessable via the internet or vpn connection that allows your Zendesk instance as a referrer. If in doubt, give it a shot to see if your page loads first.

When installing, you need to specify the JSON settings file. Each location can be configured separately. Use the default JSON provided in the Setup or copy from below. The JSON must be present for all locations for the app to work. Just set any URL value to a blank string if you do not want the app to appear in that location.

Location Settings:

• location

• Each location that the app can display (ticketeditor, leftnav, topnav, ticketsidebar, newticketsidebar, usersidebar, organizationsidebar

• url

• The valid URL location of the iframe to display in the location. If you don't want to use the location in Zendesk, set the url to an empty string

• additional_fields

  • The additional fields specified are the url parameters added to the querystring for the iframe. You can use the included iframetest.html file to validate that your fields are pulling in correctly. All fields available from the Zendesk documentation can be used in the locations specified.
  • The format is an array of properties for the queryparam and queryvalue as such [ { "queryparam": "ticketid", "queryvalue": "ticket.id" } ] The output would look like https://test.html?ticketid=88 where 88 is the result of the ticket.id value
• width

• The width can be set differently for each location in pixels (px), view width (vw), or percent (%). Not all locations can use each type such as the navbar as this does not respect width or height, topbar, and ticket_editor only respect px.

• height

• The height can be set differently for each location in pixels (px), view width (vw), or percent (%). Not all locations can use each type such as the navbar as this does not respect width or height, topbar, and ticket_editor only respect using px.

• allowpopout

• By setting the allow popout value to true, an icon will display in the top right of each of the available locations in Zendesk to allow you to click to expand the iframe out into a larger modal window within Zendesk. The same parameters will be passed into the iframe as in the location specified it will just show larger to be able to use easier for spaces where the iframe may need more space to display properly

The included test page will help sort out any issues with referencing parameters before making available.