Click SDK
The Click SDK is the JavaScript library your development team installs to bring Propper Click into your product. Once set up, it handles rendering your agreements, collecting user responses, and recording legally compliant evidence — all without leaving your site.
Screenshot: click-sdk-flow, a web app showing a modal agreement rendered inline, with an arrow indicating the acceptance being recorded in Propper
What your developers will set up
The SDK integration covers four steps, each with its own guide in this section:
- Install — Add the SDK to your application via npm or a script tag.
- Initialize — Configure it once with your API key, environment, and user identity.
- Choose a rendering mode — Decide how agreements appear: inline within a page, as a blocking modal overlay, or as a non-blocking popup.
- Handle events — React when a user accepts, declines, or closes the agreement.
For more control over appearance and behavior, see Customization. For complex integration patterns, see Advanced Usage.
Before your developers start
Three things need to be in place before any code is written:
| Prerequisite | Where to set it up |
|---|---|
| A published template — choose the right type first | Creating Templates |
| An active deployment | Deploying Agreements |
| An API key | Click Settings → API Keys |
The Quickstart walks through all the pre-SDK steps — creating a template, publishing it, and setting up a deployment — before handing off to your development team.
Start here: Install the SDK →