Channel framework startup tutorial - Step 6: Connect the integration service to Zendesk Support - Part 2 (Zendesk app)
After the work in step 5A, your integration service can return a manifest to Zendesk Support. The manifest describes the location of the other endpoints. However, you still need to inform Zendesk Support of the url to the manifest. This is done via Zendesk app requirements.
An app requirement is the way to specify app dependencies. In the Channel framework case, the dependency is “read the manifest and register the integration service.”
You need a Zendesk Support account to test this step.
Zendesk publishes sample apps in a Github repository . To get your Zendesk Support account working with your local integration, clone the repository and modify the requirements.json of this app: https://github.com/zendesk/demo_apps/tree/master/v2/support/requirements_only_sample_app
Replace everything in requirements.json with this:
(See below for what
In this tutorial, the integration service you built runs locally, so Zendesk Support can’t reach the integration service directly. To test the integration service, you can use a tunneling service. It is also possible to deploy the integration service to the public extranet. This tutorial doesn’t cover that. You can use the ngrok tunnel tool to allow Zendesk Support to communicate with the Integration Service running on your local machine.
- Download the ngrok tunnel application from ngrok website and unzip it
ngrok http 3000. Ngrok will set up a public address for the WordPress integration service running on port 3000.
In the ngrok interface, you can see the public address which you will put into requirements.json. In this example,
Note : The Channel framework requires https.
Note : The free version of ngrok doesn’t support a fixed subdomain. Make sure you don’t restart ngrok or you will need to modify and reinstall the Zendesk app again. It is fine to restart the integration service or WordPress server.
To build the Zendesk app, you need to have the Zendesk Apps Tools (ZAT). Refer to Installing and using ZAT.
After filling in the integration_service_location in requirements.json, run the
zat package command in the /requirements_only_sample_app directory to get a Zendesk app zip file. Follow the upload and install instruction to upload and install the local Zendesk app in your instance of Zendesk Support.
After the Zendesk app installs successfully, you can navigate to the Channels > Channels Integration section in admin UI to see the newly added integration:
Navigate into the 'WordPress' integration and you can setup an integration account using the 'Add account' button:
You should see the Admin UI you built in Step 5:
If everything works successfully, the ngrok tunnel should show some pull calls from Zendesk Support after a few moments:
Comments on WordPress posts should become tickets in Zendesk Support.
In addition to setting up the integration service, the Zendesk app may also have other code in it to enhance the Zendesk Support UI. See Zendesk apps resources.