Zendesk
Visualize Zendesk accounts, groups, organizations, tickets, and users, and monitor changes through queries and alerts.
- Installation guide
- Zendesk data model
Installation
JupiterOne's Zendesk integration requires an OAuth App to be created within your Zendesk and authenticating JupiterOne with Zendesk after you have created the OAuth application.
Though it is not required, a Zendesk Pro account provides more data resources to JupiterOne than a regular Zendesk account.
Configuration in Zendesk
You will need to create the OAuth application to successfully integrate Zendesk with JupiterOne:
- Create an OAuth app in Zendesk by going to your Zendesk Admin Center and navigating to Apps and integrations > APIs > Zendesk APIs.
- This can be accessed here:
https://{your-zendesk-subdomain}.zendesk.com/admin/apps-integrations/apis/apis/oauth_clients.
) though, be sure to input your Zendesk subdomain.
- This can be accessed here:
- Click on the Add OAuth Client button.
- Provide information for the OAuth app, and enter 'http://localhost:5000/redirect' as the redirect URL for OAuth.
See Zendesk's documentation for additional assistance configuring an Oauth application.
Configuration in JupiterOne
To install the Addigy integration in JupiterOne, navigate to the Integrations tab in JupiterOne and select Addigy. Click New Instance to begin configuring your integration.
Creating a configuration requires the following:
The Account Name used to identify the Addigy account in JupiterOne. Ingested entities will have this value stored in
tag.AccountName
when theAccountName
toggle is enabled.Description to assist in identifying the integration instance, if desired.
Polling Interval that you feel is sufficient for your monitoring needs. You may leave this as
DISABLED
and manually execute the integration.Your Zendesk Subdomain
- e.g.,
https://{this-is-your-zendesk-subdomain}.zendesk.com
- e.g.,
Click Create once all values are provided. You will be redirected to authenticate JupiterOne with Zendesk via OAuth flow. Once you complete the authentication process, your integration will be ready for use.
Next steps
Now that your integration instance has been configured, it will begin running on the polling interval you provided, populating data within JupiterOne. Continue on to our Instance management guide to learn more about working with and editing integration instances.
Data Model
Entities
The following entities are created:
Resources | Entity _type | Entity _class |
---|---|---|
Account | zendesk_account | Account |
Group | zendesk_group | Group |
Organization | zendesk_organization | Organization |
Ticket | zendesk_ticket | Record |
User | zendesk_user | User |
Relationships
The following relationships are created:
Source Entity _type | Relationship _class | Target Entity _type |
---|---|---|
zendesk_account | HAS | zendesk_organization |
zendesk_group | HAS | zendesk_ticket |
zendesk_group | HAS | zendesk_user |
zendesk_organization | HAS | zendesk_group |
zendesk_user | ASSIGNED | zendesk_ticket |
zendesk_user | OPENED | zendesk_ticket |