Browse Guides

Google reCAPTCHA Integration
Reading mode
Copy Link
Link Copied!
Print
Feedback
This guide has multiple versions available:
<style>p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><p><strong>In this guide we will cover:</strong></p><p><strong>- What is the Google reCAPTCHA Integration?</strong></p><p><strong>- Connecting to reCAPTCHA&nbsp;</strong></p><p><strong>- Adding to Anonymous Ticket Logging</strong></p><p><strong>- Adding to Feedback Forms</strong></p><p><br></p><p><br></p><p><strong>Related Guides:</strong></p><ul><li style="font-weight: bold;"><strong><a href="https://usehalo.com/haloitsm/guides/2073" target="_blank" rel="noopener noreferrer">Anonymous logging for certain ticket types, can be embedded on website or accessed via a specific URL</a>&nbsp;</strong></li><li style="font-weight: bold;"><strong><a href="https://usehalo.com/haloitsm/guides/1944" target="_blank" rel="noopener noreferrer">One-Click Feedback</a></strong></li></ul><p><br></p><p><strong><span style="font-size: 14pt;">What is the Google reCAPTCHA Integration?<br></span></strong></p><p>The Google reCAPTCHA integration can be used to allow for security validation when users log anonymous tickets or submit survey feedback.&nbsp;</p><p><br></p><p><strong><span style="font-size: 14pt;">Connecting to reCAPTCHA</span></strong></p><p>Log in to Google Cloud via <a data-fr-linked="true" href="https://www.google.com/recaptcha/admin" id="isPasted">https://www.google.com/recaptcha/admin</a>, and navigate to the site configuration. Click the &quot;+&quot; icon to create a new site.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImY1MWYxYzdkLWYyMmQtNGZjMS05MzI2LWRhNzViYmM1NzNjZSJ9.M6SvGlT9zZptZoeLUz3X4G7uEq8SiFE88VUgbADluZ8" class="fr-fic fr-fil fr-dib" width="1139" style="width: 1141px; height: 543.096px;" height="543"></p><p><strong><span style="font-size: 10pt;">Fig 1. Viewing an existing reCAPTCHA site.</span></strong></p><p><br></p><p>A page will appear with a list of fields to complete. Set a relevant label for your reCAPTCHA site, such as &quot;Halo&quot;.</p><p><br></p><p>Next, choose a reCAPTCHA type to use. The method selected here must match the method selected within the Halo configuration, which will be covered shortly. This guide will be showcasing the &quot;I&#39;m not a robot&quot; checkbox method from v2 as the visible option. For detailed information on each method, check out the Google documentation on &quot;<a href="https://developers.google.com/recaptcha/docs/versions" target="_blank" rel="noopener noreferrer"><strong>Choosing the type of reCAPTCHA</strong></a>&quot;.</p><p><br></p><ul><li><strong>Score based (v3)</strong> - verify requests with a score.</li><li><strong>Challenge (v2) &quot;I&#39;m not a robot&quot; Checkbox</strong> - validate requests with the &quot;I&#39;m not a robot&quot; checkbox.</li><li><strong>Challenge (v2) Invisible reCAPTCHA badge</strong> - validate requests in the background.</li></ul><p><br></p><p>Next, set the end part of your Halo domain into the domain field.</p><p><br></p><p>i.e. &quot;https://myURL.halopsa.com/&quot; will be &quot;halopsa.com&quot;</p><p><br></p><p>Once complete, submit the form.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjMxYmI1MWQyLWY2NWQtNGRkNy1iMmJjLTAxZjE4NGM1ZDEzYSJ9.rez9FjNglpbFNJFU6myyiuwMplv--kTG8AMb1UUK9kk" class="fr-fic fr-fil fr-dib" width="1137" style="width: 1139px; height: 541.265px;" height="541"></p><p><strong><span style="font-size: 10pt;">Fig 2. Creating a site.</span></strong></p><p><br></p><p>A new page will then show with the site key and secret key generated. Copy these, and make note of them for the duration of this setup. It is recommended to keep this tab open whilst configuring the rest of the integration.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjA5ODdiMzBlLTQ0ZjMtNDZiNy1hNTE1LWRmZjlmN2RmNzZkNyJ9.f3o2riIKh6FUjkqmU-gpFVQfWqi0Wnl2738iyXG02CM" class="fr-fic fr-fil fr-dib" width="1139" style="width: 1141px; height: 538.523px;" height="539"></p><p><strong><span style="font-size: 10pt;">Fig 3. Generating a site key and secret key.</span></strong></p><p><br></p><p>Within Halo, navigate to Configuration &gt; Integrations &gt; Miscellaneous. Hover over the Google reCAPTCHA module and click the &quot;+&quot; to enable this.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjA1Njg2ZTE2LTA2NzgtNGIzMS04NjUwLWUxNzgyNzg3YzYyYyJ9.f64Y3kQqkeP0woS4_XQ4aT-ZZbTsiUnjFCF9KKkmk94" class="fr-fic fr-fil fr-dib" width="85" height="123"></p><p><strong><span style="font-size: 10pt;">Fig 4. Enabling the module.</span></strong></p><p><br></p><p>Click into the module, where you will see fields to enter the site and secret keys that we made note of in <strong>Fig 3</strong>.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImI5NTljMWNlLWJhNDUtNDgwNS1hMmRmLTlmOWU2M2FhYWY2ZiJ9.QTmmMKts3-JVLIuTls0g6aLn1vqnKzwGbeMx1-Hc78I" class="fr-fic fr-fil fr-dib" width="1139" style="width: 1141px; height: 182.714px;" height="183"></p><p><strong><span style="font-size: 10pt;">Fig 5. Connecting to the Google site.</span></strong></p><p><br></p><p>Here, choose the reCAPTCHA type for this connection. The method selected here must match the &quot;reCAPTCHA type&quot; selected in <strong>Fig 2</strong> when creating the site.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImRhMDcxYzM5LTAwOTQtNDJiZi1iMGEyLWM5YWQ4MTExYTgzNCJ9.CPgVrByGJ_YaCgmEY1KYCPChvYfXnGP3wwIRC2BCnAY" class="fr-fic fr-fil fr-dib" width="502" height="190"></p><p><strong><span style="font-size: 10pt;">Fig 6. reCAPTCHA type options.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Adding to Anonymous Ticket Logging</span></strong></p><p>The first way reCAPTCHA validation can be used is when users log anonymous tickets. To allow anonymous ticket logging, go to Configuration &gt; Tickets &gt; Ticket Types &gt; Details tab and enable &quot;Allow Users to log this ticket type anonymously&quot;.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjJjODdmNzEwLTVlNzUtNDAzOS1hZGU5LTQ0NTRkNTg3OGEwNSJ9.v_mkGcuwrwa8lGEoBn07-62x-jxBLaXMi3K49ZBqaiM" class="fr-fic fr-fil fr-dib" width="625" height="748"></p><p><strong><span style="font-size: 10pt;">Fig 7. Allowing anonymous ticket logging.</span></strong></p><p><br></p><p>Within the &quot;Forms&quot; tab, a URL will be generated. This is the URL that users can use to log these tickets anonymously. This link can be shared with your users in whichever way you wish.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImVlNWM3NzMzLTVlNjUtNDVkMS04YjU2LWEyN2JjNTgwMmMyMCJ9.PnNAF6IReKfxljzwVoOL7PnCRCNSAY56KYNxBBSwS4I" class="fr-fic fr-fil fr-dib" width="1135" style="width: 1137px; height: 464.565px;" height="465"></p><p><strong><span style="font-size: 10pt;">Fig 8. Anonymous logging ticket link.</span></strong></p><p><br></p><p>When navigating to that URL, the reCAPTCHA checkbox shows at the bottom of the ticket form. The submit button is a paler colour and does not allow the ticket to be logged until this is completed.</p><p><br></p><p>The reCAPTCHA will not show if a user is logging the same ticket type whilst logged in.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImIxYzBlODViLTUwOGMtNDgwYi05MmZkLWM0MzRjOGExMWVhZSJ9.IhO2hrt7JBoyhuvaEkd8jWvLa_SZgsQVXDWZwrPh6YE" class="fr-fic fr-fil fr-dib" width="1134" style="width: 1136px; height: 351.562px;" height="352"></p><p><strong><span style="font-size: 10pt;">Fig 9. reCAPTCHA verification when logging an anonymous ticket.</span></strong></p><p><br></p><p>Upon clicking the checkbox, the user may be prompted to complete an image task.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjFjODY5ZDYyLTQzMjktNDEzYS1iZGIwLWUxYjkzMjgyMTQzNCJ9.BvhlbYBBr0qXdHLhJ2sinqOjechOzId-pf8MZbRwc7U" class="fr-fic fr-fil fr-dib" width="1132" style="width: 1134px; height: 488.793px;" height="489"></p><p><strong><span style="font-size: 10pt;">Fig 10. Image task example.</span></strong></p><p><br></p><p>If successful, the checkbox will be marked as complete and the ticket will be able to be logged.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImM3OWU4OTM5LTM4ODUtNGJiZi05ZDBhLTU0MDdhMmY1ODAyMCJ9.ivn3WBwE6ZbAPfmriBRQ4G0NF7-ZfGPU3onlRIGK7N0" class="fr-fic fr-fil fr-dib" width="1131" style="width: 1133px; height: 350.178px;" height="350"></p><p><strong><span style="font-size: 10pt;">Fig 11. Completed validation.</span></strong></p><p><br></p><p>If the completed validation is left too long, the verification will expire.</p><p><br></p><p><img data-fr-image-pasted="true" src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImJkYTViZDkwLWM1NDUtNGUzMy1iNzdlLTQ2N2E3NzExMjAwMCJ9.caJgNdvLegc8KelxjLFy2Rzx2Zx1eloor7biFBwiLRI" width="1136" height="354" style="box-sizing: inherit; border-style: none; cursor: pointer; padding: 0px 1px; user-select: none; text-align: left; color: rgb(0, 0, 0); font-family: sans-serif; font-size: 14px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space: normal; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; width: 1138px; height: 354.39px; max-width: none !important;" id="isPasted" class="fr-fil fr-dib"><strong><span style="font-size: 10pt;">Fig 12. Expired validation.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Adding to Feedback Forms</span></strong></p><p>reCAPTCHA can also be used for feedback validation. This is useful if you have customers who use virus checkers that click every link in an email, thus distorting the feedback logged. Within Configuration &gt; Integrations &gt; Miscellaneous &gt; Google reCAPTCHA, enable the below checkbox.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjMwNjliMjMxLTk4ZDQtNGU4Ni04Y2NiLTQ3NmI2ODk1MGM2YyJ9.zTIFT6J90NZE_nbY0Ty0VmOmRFb68Mvsk9FY_5Cx9kw" class="fr-fic fr-fil fr-dib" width="231" height="27"></p><p><strong><span style="font-size: 10pt;">Fig 13. Enabling feedback validation.</span></strong></p><p><br></p><p>When viewing the feedback screen, the reCAPTCHA is then required before submitting.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImY3MTEzYjRmLTc2MDktNDc0My05MDdmLTNiYzI1NTU3MWQ3MCJ9.lW9DENbFdY_9HvIUcEjY7CHH6zIPIqvnk15y8XyEvMA" class="fr-fic fr-fil fr-dib" width="1113" style="width: 1115px; height: 360.735px;" height="361"></p><p><strong><span style="font-size: 10pt;">Fig 14. Validation when logging feedback.</span></strong></p><p><br></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.