Community
Questions Library
Docs
Blog
Events
Swag
Github
Slack
JupiterOne
Discussions
Release Notes
Contact Us
Zendesk - AskJ1 Community
<main> <article class="userContent"> <h2 data-id="zendesk-jupiterone-integration-benefits">Zendesk + JupiterOne Integration Benefits</h2> <ul><li><p>Visualize Zendesk account, groups, organizations, tickets and users in the<br> JupiterOne graph.</p></li> <li><p>Monitor changes to Zendesk resources using JupiterOne alerts.</p></li> </ul><h2 data-id="how-it-works">How it Works</h2> <ul><li><p>JupiterOne periodically fetches account, groups, organizations, tickets and<br> users from Zendesk to update the graph.</p></li> <li><p>Write JupiterOne queries to review and monitor updates to the graph, or<br> leverage existing queries.</p></li> <li><p>Configure alerts to take action when JupiterOne graph changes, or leverage<br> existing alerts.</p></li> </ul><h2 data-id="requirements">Requirements</h2> <ul><li><p>Zendesk supports the OAuth2 Client Credential flow. You must have a<br> Administrator user account.</p></li> <li><p>You must have permission in JupiterOne to install new integrations.</p></li> </ul><h2 data-id="support">Support</h2> <p>If you need help with this integration, please contact<br><a rel="nofollow" href="https://support.jupiterone.io">JupiterOne Support</a>.</p> <h2 data-id="integration-walkthrough">Integration Walkthrough</h2> <h3 data-id="in-zendesk">In Zendesk</h3> <ol><li><p>Register for a Zendesk account. A pro account is not required but some<br> resources may not be ingested without it.</p></li> <li><p>Create an OAuth app by going to<br><a rel="nofollow" href="https://subdomain.zendesk.com/admin/apps-integrations/apis/apis/oauth_clients">https://subdomain.zendesk.com/admin/apps-integrations/apis/apis/oauth_clients</a>.<br> (click on the 'Add OAuth Client' button)</p></li> <li><p>Enter '<a rel="nofollow" href="http://localhost:5000/redirect">http://localhost:5000/redirect</a>' as the redirect URL for OAuth.</p></li> <li><p>Generate an API token by going to<br><a rel="nofollow" href="https://subdomain.zendesk.com/admin/apps-integrations/apis/apis/settings">https://subdomain.zendesk.com/admin/apps-integrations/apis/apis/settings</a>.<br> (click on the 'Add API Token' button)</p></li> <li><p>Take note of your <code class="code codeInline code codeInline" spellcheck="false" tabindex="0">Client ID</code>, <code class="code codeInline code codeInline" spellcheck="false" tabindex="0">Client Secret</code>, <code class="code codeInline code codeInline" spellcheck="false" tabindex="0">Redirect URI</code> and<br><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">API token</code> and supply them to the<br><a rel="nofollow" href="../oauth-server/.env">oauth server's .env file</a>.</p></li> <li><p>The app is now ready. Proceed to authentication to generate your<br><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">ZENDESK_ACCESS_TOKEN</code>.</p></li> </ol><h3 data-id="in-jupiterone">In JupiterOne</h3> <ol><li>From the top navigation of the J1 Search homepage, select <strong>Integrations</strong>.</li> <li>Scroll to the <strong>Zendesk</strong> integration tile and click it.</li> <li>Click the <strong>Add Configuration</strong> button and configure the following settings:</li> </ol><ul><li><p>Enter the <strong>Account Name</strong> by which you'd like to identify this Zendesk<br> account in JupiterOne. Ingested entities will have this value stored in<br><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">tag.AccountName</code> when <strong>Tag with Account Name</strong> is checked.</p></li> <li><p>Enter a <strong>Description</strong> that will further assist your team when identifying<br> the integration instance.</p></li> <li><p>Select a <strong>Polling Interval</strong> that you feel is sufficient for your monitoring<br> needs. You may leave this as <code class="code codeInline code codeInline" spellcheck="false" tabindex="0">DISABLED</code> and manually execute the integration.</p></li> <li><p>{{additional provider-specific settings}} Enter the <strong>Zendesk API Key</strong><br> generated for use by JupiterOne.</p></li> </ul><ol start="4"><li>Click <strong>Create Configuration</strong> once all values are provided</li> </ol><h1 data-id="how-to-uninstall">How to Uninstall</h1> <ol><li>From the top navigation of the J1 Search homepage, select <strong>Integrations</strong>.</li> <li>Scroll to the <strong>Zendesk</strong> integration tile and click it.</li> <li>Identify and click the <strong>integration to delete</strong>.</li> <li>Click the <strong>trash can</strong> icon.</li> <li>Click the <strong>Remove</strong> button to delete the integration.</li> </ol><h2 data-id="data-model">Data Model</h2> <h3 data-id="entities">Entities</h3> <p>The following entities are created:</p> <table><thead><tr><th>Resources</th> <th>Entity <code class="code codeInline code codeInline" spellcheck="false" tabindex="0">_type</code></th> <th>Entity <code class="code codeInline code codeInline" spellcheck="false" tabindex="0">_class</code></th> </tr></thead><tbody><tr><td>Account</td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_account</code></td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">Account</code></td> </tr><tr><td>Group</td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_group</code></td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">Group</code></td> </tr><tr><td>Organization</td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_organization</code></td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">Organization</code></td> </tr><tr><td>Ticket</td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_ticket</code></td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">Record</code></td> </tr><tr><td>User</td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_user</code></td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">User</code></td> </tr></tbody></table><h3 data-id="relationships">Relationships</h3> <p>The following relationships are created:</p> <table><thead><tr><th>Source Entity <code class="code codeInline code codeInline" spellcheck="false" tabindex="0">_type</code></th> <th>Relationship <code class="code codeInline code codeInline" spellcheck="false" tabindex="0">_class</code></th> <th>Target Entity <code class="code codeInline code codeInline" spellcheck="false" tabindex="0">_type</code></th> </tr></thead><tbody><tr><td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_account</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_organization</code></td> </tr><tr><td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_group</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_ticket</code></td> </tr><tr><td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_group</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_user</code></td> </tr><tr><td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_organization</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_group</code></td> </tr><tr><td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_user</code></td> <td><strong>ASSIGNED</strong></td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_ticket</code></td> </tr><tr><td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_user</code></td> <td><strong>OPENED</strong></td> <td><code class="code codeInline code codeInline" spellcheck="false" tabindex="0">zendesk_ticket</code></td> </tr></tbody></table> </article> </main>
.png)