This topic will provide you with an overview of Clickwrap Guides. This includes what they are and how they function.
This topic is specific to the New Clickwrap Experience. If you are using the Classic Clickwrap Experience, refer to the Classic Clickwrap Experience documentation.
- What is a Guide?
- How Does a Guide Work?
- What is the Difference Between a Playground and a Published Guide?
What is a Guide?
Implementation of any third party code can be daunting, especially for legal teams who may be less familiar with working with engineering teams. Many customers getting started with Clickwrap have questions like:
- Which snippets of code should I use?
- What are best practices for tracking acceptance when a counterparty clicks a button?
- How can I short circuit the process of integration for my technical team?
- What did we actually end up implementing?
Additionally, for every Clickwrap group you’ve setup, you may have different places or ways you want to present and track acceptance across different websites, URLs, apps, and more.
Clickwrap Guides allow you to set up and publish the details behind your Ironclad Clickwrap integration. Guides are designed to bring your legal, business, and technical teams together to define and finalize how you’ll present and track Clickwrap agreements for a particular Clickwrap Group.
How Does a Guide Work?
Through a series of questions, you’ll shape the personalized blueprint and snippets of code you will need to implement Clickwrap inside your website and native apps. Answering questions in a Guide will yield both Instructions and a Preview on the right hand side of the screen:
- Instructions are personalized to each Guide, and give your technical team the context and code snippets that follow the decisions you’ve made on how to present and track acceptance in your Clickwrap agreement.
- The Preview will reflect answers to your questions with a working preview and a log of events that are fired by the Clickwrap platform.
When creating a Guide, your “Playground” or draft Guide will only be available to you. You can change decisions, interact with the preview to see how it works, and share a link to your Playground for someone else to modify and explore.
When you click Publish, the Guide is then shared with your entire team.
What is the Difference Between a Playground and a Published Guide?
There are two forms of Guides in your account: Playgrounds and Published Guides. A Playground is a Guide that is being tested as a draft. It’s only available to the user who created it (you) and can be edited and changed in real-time. Playgrounds and Guides relate to one another as demonstrated in the following examples:
- A Clickwrap group can have manyGuides. You may want to use multiple Guides on a Clickwrap group when implementing across web, iOS, and Android.
- A Guide can have manyPlaygrounds. You may want to test a new configuration or setup behind a Clickwrap group. You can create a new Playground or clone a published Guide.
A Published Guide creates a new version so that the blueprint for your implementation of Clickwrap is kept up to date.
The Guide for Desktop Web serves as the implementation blueprint for a Clickwrap Group. Each Playground allows you to tinker individually and publish your Guide once it’s finalized and ready to go. Publishing a Playground in the image’s instance would yield a “v2” of the Desktop Web Guide.