Zendesk Integration Guide - HL Vanilla Community
<main> <article class="userContent"> <p>šĀ <strong>NOTE</strong>: This article pertains to integrating your <strong>Higher Logic Vanilla</strong> (<strong>Vanilla</strong>) community with your <em>Zendesk help center</em>.</p><p>āļø <strong>TIP</strong>: For information on Vanilla's <em>Zendesk Guide</em> <strong>Search Connector</strong>, see:</p><div class="js-embed embedResponsive" data-embedjson="{"body":"Federated Search is an addon that enhances your Higher Logic Vanilla (Vanilla) community search by automatically including content from external platforms, such as Zendesk Guide. This broader search provides a real benefit to your users: they get more results, from multiple sources, returned to them in a central locationā¦","photoUrl":"https:\/\/us.v-cdn.net\/6030677\/uploads\/VWGAXAF5OFCO\/microsoftteams-image.png","url":"https:\/\/success.vanillaforums.com\/kb\/articles\/523","embedType":"link","name":"Federated Search - Vanilla Success"}"> <a href="https://success.vanillaforums.com/kb/articles/523" rel="nofollow noreferrer ugc"> https://success.vanillaforums.com/kb/articles/523 </a> </div><h2 data-id="integration-highlights">Integration highlights</h2><p>If you're using a Zendesk help center, you can integrate it with Vanilla in order to:</p><ul><li>Link your Zendesk account to your Vanilla user profile.</li><li>Submit usersā discussions and comments as tickets to your Zendesk help center's ticketing system.</li></ul><p>šĀ <strong>NOTE</strong>: You must have a Zendesk account to use this integration. If you donāt have a Zendesk account, visitĀ <a href="http://www.zendesk.com/" rel="nofollow noreferrer ugc">Zendesk</a>.</p><h2 data-id="set-up-the-integration">Set up the integration</h2><p>You have to enable API Access in your Zendesk account for this plugin to work.</p><ol><li>Login to your Zendesk site.</li><li>Go to the Admin Setting.</li><li>Under Channels, select API.</li><li>Select the OAuth Clients.</li><li>Add a client.</li><li>Complete the form.</li><li>Copy the Unique Identifier and Secret and enter it below.</li><li>Set the Redirect URLs by appendingĀ <code class="code codeInline" spellcheck="false" tabindex="0">/profile/zendeskconnect</code>Ā and <code class="code codeInline" spellcheck="false" tabindex="0">/plugin/zendesk/connect</code>Ā to your forumās URL, as shown below.</li></ol><h3 data-id="redirect-url-examples">Redirect URL examples</h3><p>If your forum URL is:</p><ul><li>https://forum.example.com/</li></ul><p>...your Redirect URLs will be:</p><ul><li>https://forum.example.com/<strong>profile/zendeskconnect</strong></li><li>https://forum.example.com/<strong>plugin/zendesk/connect</strong></li></ul><p>If your forum URL is:</p><ul><li>https://forum.example.com/en/</li></ul><p>...your Redirect URLs will be:</p><ul><li>https://forum.example.com/en/<strong>profile/zendeskconnect</strong></li><li>https://forum.example.com/en/<strong>plugin/zendesk/connect</strong></li></ul><h2 data-id="link-your-vanilla-zendesk-accounts">Link your Vanilla & Zendesk accounts</h2><ol><li>Log in to your Vanilla profile page.</li><li>Edit your profile.</li><li>Click the <strong>Connections</strong> option to access the Connections page (<strong>/profile/connections</strong>).</li><li>Click the <strong>Connect</strong> button for Zendesk.</li><li>Follow the instructions to link your Vanilla and Zendesk accounts.</li></ol><h2 data-id="troubleshooting">Troubleshooting</h2><p><strong>Issue</strong>: When I try to link my account I get the error:</p><p><code class="code codeInline" spellcheck="false" tabindex="0">Invalid Authorization Request. bad_request</code></p><p><strong>Check</strong>: Make sure that the URL you are on when you are in theĀ <strong>Social</strong>Ā section of your profile matches the Redirect URLs that you set in the configuration.</p><p>āļø <strong>EXAMPLE</strong>: When you are in your profile's <strong>Social</strong>Ā section, if the URL is</p><p><code class="code codeInline" spellcheck="false" tabindex="0">https://forum.example.com/somedirectory/profile/connections</code></p><p>...then, <em>in your configuration</em>, you should have</p><p><code class="code codeInline" spellcheck="false" tabindex="0">https://forum.example.com/somedirectory/<strong>profile/zendeskconnect</strong></code></p><p>...and</p><p><code class="code codeInline" spellcheck="false" tabindex="0">https://forum.example.com/somedirectory/<strong>plugin/zendesk/connect</strong></code></p><h3 data-id="addon-settings">Addon settings</h3><p>If the URLs above are correct but the issue persists, check the URL in the <strong>Your Zendesk URL</strong> field of the Zendesk addon settings page (in <strong>Settings > Addons > Addons > Zendesk</strong>).</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/H1SXTBN2C6NV/settings.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/H1SXTBN2C6NV/settings.png" alt="Settings.png" height="331" width="524" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <ul><li>Make sure that the URL uses the <strong>https</strong> (<em>secure</em>) protocol.</li></ul><p>šĀ <strong>NOTE</strong>: If the protocol is (the less secure) <strong>http</strong>, Zendesk will reject the connection request.</p> </article> </main>