You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+42-16Lines changed: 42 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,59 +2,74 @@
2
2
3
3
# Zendesk gridX Health Check
4
4
5
-
Zendesk gridX Health Check is a Zendesk Support App that allows running checks against gridBoxes in the field.
5
+
Zendesk gridX Health Check is a Zendesk Support App that allows running predefined tests and plausibility checks against gridBoxes in the field.
6
+
6
7
7
8
8
9
## Synopsis
9
10
10
-
gridX provides a suite of health checks for gridBoxes [via API](https://community.developer.gridx.de/t/gridx-api-documentation/213#post-/health-checks). We use this internally within our support team to help them diagnose issues and mis-configuration of devices in the field more efficiently.
11
+
gridX provides a suite of health checks for gridBoxes [via API](https://community.developer.gridx.de/t/gridx-api-documentation/213#post-/health-checks).
12
+
We use it internally within our support team to help them diagnose issues and mis-configuration of devices in the field more efficiently.
13
+
11
14
New checks are made available on a regular basis to cover additional scenarios as they become know.
12
15
These checks will be available in Zendesk through this app automatically without having to update this app.
13
16
14
17
## 📖 Usage
15
18
16
-
The app takes a gridBox serial number as input and runs all available checks against it. It reports the result along with a description of checks and some metadata about failures. If the serial number is available in a custom field, it uses it automatically.
19
+
The app takes a gridBox serial number as input and runs [all available checks](https://community.developer.gridx.de/t/gridx-api-documentation/213#get-/health-checks) against it.
20
+
It reports the result along with a description of checks and some metadata about failures. If the serial number is available in a custom field, it uses it automatically.
21
+
17
22
That's it.
18
23
19
24
## 📦 Installation
20
25
21
26
To install the App into your Zendesk instance, proceed as follows.
22
27
23
-
1. Make sure you have a policy group having the `HealthCheckRequest` permission set up
28
+
1. Make sure you have a policy group having the `HealthCheckRequest` permission set up. Copy the group ID from the URL.
24
29
25
30
2. Create an organizational token for gridX API access as described in the [gridX developer community](https://community.developer.gridx.de/t/good-practice-using-organizational-tokens/152#p-230-creating-an-organizational-token-2)
26
-
and make note of it.
31
+
and note it down.
27
32
```sh
28
33
curl -X POST "https://api.gridx.de/account/tokens" \
29
34
-H 'accept: application/vnd.gridx.v2+json'\
30
35
-H 'content-type: application/json' \
31
36
-d '{"description":"gridX Zendesk Token","expiresAt":"2025-03-18T17:37:59Z","email":"[email protected]","groups":["<group id from step 1>"]}'
32
37
```
33
-
3. Get the [latest release](https://github.com/grid-x/zendesk-gridx-health-check/releases/latest) from this repository.
34
-
4. Download the `.zip`file
38
+
3. Get the [latest release](https://github.com/grid-x/zendesk-gridx-health-check/releases/latest) from this repository and download the `.zip`file
35
39
36
-
5. Open your Zendesk admin console (`your-instance.zendesk.xom/admin/apps-integrations/apps/support-apps`)
37
-
6. Select `Upload private app`
40
+
4. Open your Zendesk admin console (`your-instance.zendesk.xom/admin/apps-integrations/apps/support-apps`)
41
+
5. Select `Upload private app`
38
42
39
43
1. Enter `gridX Health Check` as name, select the `.zip` file downloaded before and `Upload` it
40
44
41
45
1. Proceed at the next dialog
42
46
43
-
2. On the configuration screen, enter the following and click `Install`
44
-
1. The API token created previously
45
-
2. Whether you want to see additional debug information in the
47
+
2. On the configuration screen, enter the following, then click `Install`
48
+
1. The **API token** created previously
49
+
2. Whether you want to see additional **debug** information in the
46
50
browser's development console
47
-
3. Optionally, the ID of the custom field holding the gridBox serial number,
51
+
3. Optionally, the **ID of the custom field** holding the gridBox serial number,
48
52
if you have it set up in your Zendesk instance.
49
-
4. Role and group descriptions, if you need to.
50
-
53
+
4.**Role and group descriptions**, if you want to restrict access
54
+
55
+
51
56
3. From the `Private Apps` tab, `Install` the app to make it available.
57
+
52
58
53
59
54
-
To update, grab the new release from this repository and select `Update` from the existing App's context menu.
60
+
To update, ...
61
+
62
+
1. Grab the new release from this repository.
63
+
2. Select `Update` from the existing App's context menu.
64
+
3. Upload the new release's `.zip` archive.
65
+
4. The configuration does not need to be update usually, it'S persistent across updates.
55
66
56
67
## 🔧 Development
57
68
69
+
Feel free to fork this repository and change it as you see fit.
70
+
If you add improvements you think are beneficial for others, too:
71
+
We can't wait for your pull requests!
72
+
58
73
### Prerequisites
59
74
60
75
-[`zcli`](https://developer.zendesk.com/documentation/apps/getting-started/using-zcli/#installing-and-updating-zcli), the Zendesk development CLI tool
@@ -67,6 +82,7 @@ For additional details on building Zendesk Apps, please refer to the [scaffold r
67
82
68
83
To serve the app to your Zendesk instance with `?zcli_apps=true`, follow the steps below:
69
84
85
+
-`nvm use` - use the the proper node version for the development environment
70
86
-`npm install` - install dependencies
71
87
-`npm run dev` - in one terminal, start the dev server
72
88
-`npm run start` - in a second terminal, expose the app so it can be displayed in Zendesk
This will create a zip file ready to upload as a Zendesk Support App in `dist/tmp`.
107
+
108
+
### References
109
+
110
+
This app uses the Zendesk integration framework. Here are some pointers to their (and our) documentation.
111
+
112
+
-[gridX Developer Community](https://community.developer.gridx.de/) and [API documentation](https://community.developer.gridx.de/t/gridx-api-documentation/213)
113
+
- Making [calls against the gridX API](https://community.developer.gridx.de/t/good-practice-using-the-gridx-api-with-postman/221) and [using API authentication tokens](https://community.developer.gridx.de/t/good-practice-using-organizational-tokens/152).
114
+
-[Zendesk Garden](https://garden.zendesk.com/), their design system/widget library
115
+
- A [getting started guide](https://developer.zendesk.com/documentation/apps/build-an-app/using-react-in-a-support-app/) for React based Zendesk support apps
116
+
- A guide on [making API calls from Zendesk apps](https://developer.zendesk.com/documentation/apps/app-developer-guide/making-api-requests-from-a-zendesk-app/) and how their secure proxy works
0 commit comments