Zapier Integration - HL Vanilla Community
<main> <article class="userContent"> <h2 data-id="setting-up-vanilla-in-zapier">Setting up Vanilla in Zapier</h2><p>When you choose to use Vanilla to create a Zap, it will ask you to connect your Vanilla app. You should be able to easily connect your app by following these instructions.</p><h2 data-id="enter-your-site-url">Enter your site URL</h2><p>Enter your site's full URL, in this format: <code class="code codeInline" spellcheck="false" tabindex="0">https://{yourdomain}.com</code>.</p><h2 data-id="setting-up-your-access-token">Setting up your Access Token</h2><p>You have to provide Zapier with an Access Token so that they can authenticate your connection. To do this:</p><p>1. Access the Dashboard.</p><p>2. Navigate to <strong>Settings > Memberships > Roles & Permissions</strong>.</p><p>3. Click the <strong>pencil</strong> icon for the Administrator role and, in the <strong>Garden</strong> section, confirm that the <strong><code class="code codeInline" spellcheck="false" tabindex="0">Tokens > Add</code></strong> permission is enabled; if not, check the box to enable it.</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/PRFN760VPIUA/tokens-permission.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/PRFN760VPIUA/tokens-permission.png" alt="Tokens permission.png" height="306" width="610" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>📝 <strong>NOTE</strong>: If this is not enabled, you will receive a “Permissions Problem” error message when trying to generate a token.</p><p>4. Navigate to the <code class="code codeInline" spellcheck="false" tabindex="0">profile/tokens</code> page and click the <strong>Generate New Token</strong> button.</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/KPJ4LIAX8SAG/image.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/KPJ4LIAX8SAG/image.png" alt="image.png" height="424" width="1838" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>5. In the popup, provide a name for your token (e.g., "Zapier") and click <strong>Generate</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/FKHBSEQQJ6H7/image.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/FKHBSEQQJ6H7/image.png" alt="image.png" height="462" width="1152" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>This will generate your access token, which you can copy and paste into the Access Token field when you connect your Vanilla app to Zapier.</p><h2 data-id="setting-up-your-secret">Setting up your Secret</h2><p>You need to provide Zapier with a "secret" to secure your webhooks. We recommend that you create your secret string the exact same way you create your Access Token. Just generate a new token (naming it something like "Zapier secret") and paste the generated string into the "Secret" field in when connecting your app to Zapier. That way, if your a webhook associated with Zapier is accidentally edited, you can copy and paste the stored string from you tokens page back into your webhook's secret field. Whichever way you choose to create your secret string, it must be at least 20 characters long.</p><h3 data-id="more-about-secrets">More about Secrets</h3><p>The secret string you provide Zapier is stored on Vanilla's side on each webhook's settings page.</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/PVDWRPMSXEP6/image.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/PVDWRPMSXEP6/image.png" alt="image.png" height="648" width="1025" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p><strong>DO NOT ALTER THE SECRET STRING. </strong>If you do, your Zaps will no longer work.</p><p>However, if for some reason you do alter the secret string and your Zap no longer functions, you can (as mentioned above) retrieve the string from your tokens page and paste it into the webhook's "Secret" field. Otherwise, you will need to reconnect your Vanilla app through the Zapier site. This should restore your Zap's functionality.</p><h2 data-id="vanilla-triggers-and-actions">Vanilla Triggers and Actions</h2><p><strong>Triggers</strong> and <strong>Actions</strong> are two individual steps that, together, comprise a "Zap."</p><ul><li>Triggers are the first step; they are what leads to an automated, preconfigured action.</li><li>Actions are the second step; they are events that automatically occur as the result of a trigger.</li></ul><h3 data-id="trigger-action-example">Trigger-&-Action example</h3><p>Assume that you have a Zap set up such that <em>every time a new discussion is posted in Vanilla</em> it <em>sends out a tweet</em>. In this case:</p><ol><li>Each new discussion in Vanilla is a trigger and</li><li>The tweet that each discussion fires is an action.</li></ol><p>The two steps of this example are visualized in Zapier like this:</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/10OP45Q3O2SS/image.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/10OP45Q3O2SS/image.png" alt="image.png" height="72" width="742" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>✔️ <strong>TIP</strong>: You can learn more about Zaps and other Zapier concepts in <a href="https://zapier.com/help/create/basics/learn-key-concepts-in-zapier" rel="nofollow noreferrer ugc">Learn key concepts in Zapier</a>.</p><h3 data-id="access-vanilla's-triggers-and-actions">Access Vanilla's Triggers and Actions</h3><p>Vanilla's Triggers and Actions are accessible in the <em>Supported triggers and actions</em> section of Zapier's <a href="https://zapier.com/apps/vanilla/integrations#triggers-and-actions" rel="nofollow noreferrer ugc">Higher Logic Vanilla Integrations</a> page.</p><ul><li>The dropdown defaults to <strong>Triggers & Actions</strong>.</li><li>Click the dropdown to select exclusive groupings of <strong>Triggers</strong> or <strong>Actions</strong> which are described in the sections below.</li></ul><p>📝 <strong>NOTE</strong>: Vanilla currently has more than a dozen Triggers and a handful of Actions. We will add to these as we continue to develop our Zapier integration.</p><h3 data-id="triggers">Triggers</h3><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/FG3DUG8BDJCQ/triggers-list.jpg" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/FG3DUG8BDJCQ/triggers-list.jpg" alt="Triggers list.jpg" height="457" width="1138" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>Listed below are a few of Vanilla's more popular Triggers.</p><p>📝 <strong>NOTE</strong>: This is <strong>not</strong> a complete list. View the entire list by clicking <strong>Load more</strong> on Zapier's <em>Higher Logic Vanilla Integrations</em> page.</p><p>📝 <strong>NOTE</strong>: Some Vanilla Triggers can be <strong>filtered</strong>. We've indicated the filter options for those that are listed.</p><ul><li><strong>Article Added</strong>, <strong>Article Updated</strong>, and <strong>Article Deleted</strong> - triggers whenever an article has been added, updated, and deleted.</li><li><strong>Comment Added</strong> - triggers whenever a comment is added. Filters: category, discussion type.</li><li><strong>Discussion Added</strong> - triggers whenever a new discussion is posted. Filters: category, discussion type.</li><li><strong>Event RSVP</strong> - triggers whenever a user RSVPs for an event. (This can be configured for all RSVP response types or just a single response type.)</li><li><strong>New Notification</strong> - triggers whenever a notification is sent.</li><li><strong>Reaction Added</strong> - triggers whenever a reaction is added. Filters: category, reaction type, discussion type, discussion ID.</li><li><strong>User Added</strong> - triggers whenever a user registers on Vanilla.</li><li><strong>User Profile Change</strong> - triggers whenever a user updates their profile.</li></ul><h3 data-id="actions">Actions</h3><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/075G2JJ6297U/actions-list.jpg" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/075G2JJ6297U/actions-list.jpg" alt="Actions list.jpg" height="450" width="1142" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>Listed below are Vanilla's current Actions.</p><ul><li><strong>Assign a Role to a User</strong> - assigns a role to a user. The user's email address should be provided by the Trigger. The role can be chosen from a dropdown.</li><li><strong>Award a Badge to a User</strong> - awards a badge to the user who was specified by the Trigger.</li><li><strong>Close a Discussion</strong> - closes a discussion.</li><li><strong>Comment on a Discussion</strong> - comments on a discussion. Discussion ID and comment body should be provided by the Trigger or specified by the user who set up the Zap.</li><li><strong>Create a New Discussion</strong> - creates a new discussion. The discussion name and body should be provided by the Trigger. The posting format and category can be chosen from a dropdown.</li></ul> </article> </main>