This app demonstrates usage of the client.metadata() method to retrieve installation metadata such as app ID and installation ID. The app also demonstrates usage of the Update App Installation API to update installation metadata.
Follow these steps to get a local copy up and running.
- Zendesk Command Line (ZCLI)
- Clone the repo
git clone https://github.com/zendesk/metadata_call_demo_zaf_app.git
- Validate and package the app
zcli apps:package
- Upload the app to your Zendesk account and install. You will be prompted to enter an optional form name of your choosing, and enable or disable role restrictions. These are example installation settings defined under parameters in the
manifest.jsonfile.
Uploading and installing a private app
Defining installation settings
- Despite the app successfully updating metadata/setting values, because these values are cached by ZAF at app load time, you need to do an app refresh. This reloads the app and gets the updated values via subsequent client.metadata() calls.
- PUT /api/v2/apps/installations/{id}.json API requires administrator rights. Agent level users cannot call this API.
You can create an issue on Github, reach out in our Developer Community, or report the issue in the Zendesk Developers Slack group.