Changelog
Track the latest updates, features, and improvements to the ToughClicks platform.
Release 2.5.0 (Isle Royale) (Latest)
Release Date: TBD
The API now checks the custom and dynamic data you send and strips HTML from it, and a deactivated organization's packets, legal center and hosted pages stop working until it is reactivated. Legal centers get published dates, two new layout settings and safer custom headers and footers, and custom domains can have their own page title, description and favicon.
JavaScript Library
Added
- Deactivated organizations. When the organization behind your client token is deactivated, the library clears its cache, stops rendering packets (
render()returnsfalse) and emitstc-internal-errorwithdetail.codeset toTCErrorCode.organizationInactive("ORGANIZATION_INACTIVE"). See Error Handling - The API's reason for a
400 Bad Request(for example which data limit was exceeded) is logged withconsole.warnand included in thetc-internal-errorevent
Changed
- Same data limits as the API.
setDynamicData()andsetPacketDynamicData()accept up to 60 KB of dynamic data (there was no size check before) andsetCustomData()up to 1 KB. Both also check nesting (10 levels), the number of keys (100 in total) and key names, and returnfalsefor data that breaks a rule instead of sending a request the API would reject. Deeply nested data used to be cut off silently. See Limits and Sanitization - Keys named
__proto__,constructororprototypeare dropped from custom and dynamic data, like keys starting with$or. - After a
400from the render request, the library no longer retries withGET, which applies the same rules
API
Changed
customDataanddynamicDataare validated. Accept, Render Packet and every endpoint that takes?dynamicData=return400 Bad Requestfor data over 1 KB (customData) or 60 KB (dynamicData), nested more than 10 levels, with more than 100 keys or with invalid key names. Themessagenames the rule. See Limits- HTML is stripped from every string value in
customDataanddynamicDatabefore it is rendered or stored - Request bodies larger than 1 MB are rejected with
413 Payload Too Large - Document versions can no longer be saved with Handlebars' unescaped forms
{{{name}}}or{{&name}}; use{{name}} - Deactivated organizations. Every client endpoint (Get Packet Details, Render Packet, Accept, Verify), document rendering and the legal center answer
403with"error": "ORGANIZATION_INACTIVE"for a deactivated organization. Nothing is deleted; reactivating the organization restores access immediately - Agreement PDFs no longer load scripts, stylesheets, fonts or frames from document content;
httpsimages still load
Legal Center and Hosted Pages
Added
- Each document shows the date its version was published next to the version number
- Two layout settings in the Management Portal: sidebar width and maximum content width
- Custom domains can have their own page title, meta description and favicon, used by the legal center and the hosted acceptance and thank-you pages. See Custom Domains
- A deactivated organization's legal center, custom domain and hosted acceptance pages show "This page is unavailable"
Changed
- Custom headers and footers are sanitized like document content: scripts, event handlers,
javascript:links and iframes are removed - Custom CSS now also applies inside documents, and the theme no longer overrides document colors with
!important - Group headers pick black or white text for readable contrast. With the default blue theme they now use black text
- The dark mode and show search settings were removed: neither did anything
Release 2.4.0 (Hatteras)
Release Date: November 12, 2026
The JavaScript library now tells you when a compliance check couldn't be answered, and fixes several bugs that showed up with more than one instance on a page or after a re-render. The API's public client endpoints are tighter about which organization's data they return.
The library skips version 2.3.0 so that its version matches the ToughClicks release it ships in.
JavaScript Library
Changed
verify()failures are now visible. When a packet can't be verified (the API is unreachable or returns an error), its result still hasuserCompliant: true(fail-open, unchanged) but now also hasverificationFailed: trueandidset to the packet ID. Real answers haveverificationFailed: false. CheckverificationFailedif an unanswered check must not count as compliance. See Failed Verification
Fixed
verify()now emitstc-internal-errorwhen the API returns an error status or can't be reached. Before, only an unexpected exception emitted it, so a failed check looked the same as a real "compliant" answer- Two instances on one page sent two acceptances for every accept
- One instance's failure no longer carries over to instances created after it
- After a re-render, the packet no longer counts as "all checked" while its boxes are unticked, so automatic acceptance can't submit documents that weren't checked. An empty packet no longer counts as "all checked" either
- Calling
render()right afternew ToughClicks(...)no longer fetches every packet twice - For the Scroll display method,
openDocument()scrolls to the document instead of opening a new tab, and links whose document name contains markup open again - A static
signerIdset afterrender()now takes effect - Group labels no longer contain a doubled space
- Nothing is written to the cache on origins where caching is disabled
API
Changed
- Public client endpoints (Get Packet Details, Render Packet, Accept, Verify) only serve packets that belong to the client's own organization
- Packets list their documents in the order configured in the Management Portal, and leave out documents that have no published version
- Agreement date filters accept only
YYYY-MM-DDdates - The Management Portal API returns
403when the signed-in user's role lacks the permission an endpoint requires, and404for another organization's resources
Fixed
- Accept requests from JavaScript library 1.0.x, which send
browserContextinstead ofapplicationContext, are accepted again - Dynamic data values are no longer escaped twice (
&used to show as&), and dynamic data in a document URL is URL-encoded - Dynamic-data templates are sanitized when rendered and in agreement PDFs
Release 2.2.0 (Galveston)
Release Date: November 12, 2026
Packets with large amounts of dynamic data now render. Dynamic data used to travel in the URL, and the API's proxy rejects URLs over about 8 KB with 414 URI Too Long, so templates with many values, such as long lists of line items looped with {{#each}}, failed to load.
JavaScript Library
Changed
- Packets with dynamic data are fetched with
POST. The library sendsdynamicDatain the request body to the new render endpoint instead of the query string. Packets without dynamic data still useGETand the packet cache as before - If the render request fails and the dynamic data fits in a URL, the library retries once with the
GETrequest, so it keeps working against an API that doesn't have the render endpoint yet
Fixed
- Button Assent with the label set on the packet. When
assentActionLabelcame from the packet's configuration in the Management Portal rather than the display options,new ToughClicks(...)threw before the packet loaded and took the host page down with it. The label is now checked at render time, after the packet's configuration is merged in. A packet that still has no label is reported throughtc-internal-errorand skipped instead of throwing. Also released as 2.1.1 on August 28, 2026 - Different event types no longer cancel each other inside the debounce window.
render()could emittc-internal-errorfollowed bytc-valid, and onlytc-validwas delivered. Repeats of the same event are still coalesced
API
Added
POST /api/v1/client/{clientId}/packet/{packetId}/render, which returns the same packet as Get Packet Details withdynamicDatataken from the JSON request body. See Render Packet
Release 2.1.0 (Fidalgo)
Release Date: August 28, 2026
Adds a fourth display method for integrations where an extra click at checkout has a measurable cost.
JavaScript Library
Added
- Button Assent display method (
TCDisplayMethod.buttonAssent) — renders a conspicuous notice with no checkbox. The visitor agrees by clicking the integrator's own submit button, which the notice names. The packet becomes valid on render with a signer identifier set, so no user interaction is required assentActionLabeldisplay option, required in the new mode, naming the button the visitor presses. Also configurable per packet in the Management PortalassentActionSelectordisplay option for measuring the submit button's position as evidence of proximity to the notice- Evidence capture at acceptance: the notice text read verbatim from the page, the button label, presentation and acceptance timing, whether the notice was on screen and for how long, element geometry, and which documents the visitor opened
- New validation codes
MISSING_ASSENT_ACTION_LABELandINVALID_DISPLAY_OPTION_COMBINATION.optional: trueis rejected in the new mode, since with no checkbox there is nothing for a visitor to leave unticked - New CSS classes
.tc-assent-notice,.tc-assent-notice-text, and.tc-assent-link setOneChecked()accepts an optional third argument naming the packet to update
Changed
- Element ids for per-document elements now include the packet id, so the same document rendered in two packets produces two distinct elements. The ids change from
tc-document-<documentId>totc-document-<packetId>-<documentId>, and likewise fortc-document-input-,open-, andtc-document-scrollable-. The CSS classes documented for styling —.tc-document-checkbox,.tc-document-scrollable,.tc-document-helper-textand the modal ids — are unchanged, so this affects you only if you wrote a selector against a specific document's id. Group-mode ids are unchanged setOneChecked()called without a packet id now updates every packet containing that document, rather than only the first one found
Fixed
- Documents shared between packets. A document belonging to more than one active packet rendered colliding element ids, a label pointing at the other packet's checkbox, and state that updated only the first packet holding it — leaving every other packet permanently unchecked, so
allPacketsValidnever became true and the submit button never enabled. Per-document element ids now include the packet id, and each checkbox and document link carries its owning packet so events reach the right state tc-validnow fires afterrender()when the signer identifier is supplied directly throughsignerIdrather than throughsignerIdSelector. Previously validity was only re-evaluated on a checkbox interaction- The signer identifier input listener is no longer attached again on every re-render, which could fire the handler repeatedly after dynamic contract updates
- An unrecognized
displayMethodnow raises atc-internal-errorinstead of silently rendering nothing - Display method values are compared consistently whether they arrive in the SDK's
camelCaseform or the API'sSCREAMING_SNAKE_CASEform
API
Added
BUTTON_ASSENTadded to the packetdisplayMethodenumpacket.assentActionLabel, rejected as missing when a packet is saved in the new modeagreement.assentEvidence, accepted onPOST /client/{token}/acceptand returned on the agreement resources- Acceptance certificate PDFs render an Assent Evidence table for button assent agreements, and now describe every display method in words rather than printing the raw enum value
Management Portal
Added
- Button Assent option in packet configuration, with the required submit button label field and guidance on when the mode is appropriate
- The packet preview renders the new mode with the configured button label
Release 2.0.0 (Edisto)
Release Date: October 8, 2025
This is version 2.0 of the ToughClicks platform, codenamed "Edisto". This release represents a significant evolution of the platform with enhanced multi-packet capabilities and improved developer experience.
JavaScript Library
Added
- TypeScript enhancements and improved type definitions
- Enhanced documentation and code examples
- Better error messages and debugging capabilities
Changed
- Refined multi-packet API based on feedback
- Performance optimizations across all display methods
- Improved mobile experience
Fixed
- Edge cases in multi-packet validation
- TypeScript declaration file improvements
- Various bug fixes and stability improvements
Release 1.6.0 (Dauphin)
Release Date: May 6, 2024
JavaScript Library
Added
- Multi-Packet Support - Handle multiple document packets with individual display options
- Optional Packets - Mark packets as optional for opt-in consent flows
- Per-Packet Display Options - Configure different display methods and containers for each packet
setPacketDisplayOptions()- Set options for specific packetsgetPacketDisplayOptions()- Retrieve options for specific packetssetAllPacketDisplayOptions()- Batch configure multiple packets- Support for mixed display methods across different packets
- Enhanced event handling for multi-packet scenarios
Changed
- Constructor now accepts array of packet IDs:
new ToughClicks(token, ['id1', 'id2']) - Event handlers now receive
TCMultiPacketStatefor multi-packet usage verify()method now returns array ofTCVerificationResponse[]- Improved validation logic for optional vs. required packets
Backward Compatibility
- Single packet usage remains fully supported
setDisplayOptions()continues to work for legacy implementations- Automatic detection of single vs. multi-packet mode
Release 1.5.0 (Camano)
Release Date: February 17th, 2024
The primary new feature of Release 1.5.0 is the addition of an explicit Signer Email Address. This release also includes a few minor bug fixes, performance improvements, and deprecations.
JavaScript Library
Added
- Support for the staging environment by instantiating ToughClicks using
TCEnvironment.staging - Support for explicit Signer Email Address via
setSignerEmailAddress() - Better environment configuration options
API
Added
- Support for Dynamic Contracts by passing optional
dynamicDataquery string parameter to GET Packet and POST Acceptance - Added Dynamic Data to the generated PDF record
- Handlebars.js variable substitution in document templates
- Conditional content rendering based on dynamic data
Fixed
- An issue in PDF rendering when
CustomDatawas null CustomDatais now actually optional like it was supposed to be- Performance issue caused by HTML sanitization of terms
- Various edge cases in document rendering
Deprecated
Agreement.Userhas been deprecated in favor of the more explicitAgreement.SignerIdentifierandAgreement.SignerEmailAddressfields
Web Portal
Added
- Support on the agreements page to search by the new explicit
SignerEmailAddressfield - Enhanced search and filtering capabilities
- Better agreement export functionality
Changed
- Improved UI for managing documents and versions
- Better performance for large agreement lists
- Enhanced PDF download functionality
Release 1.4.0 (Beaver)
Release Date: December 2023
JavaScript Library
Added
setCustomData()method for attaching metadata to acceptancessetDynamicData()method for dynamic document rendering- Enhanced caching with configurable TTL via
setTTL() clearCache()method for manual cache invalidation- Improved error handling with detailed error events
Changed
- Better performance for rendering large packets
- Improved modal styling and responsiveness
- Enhanced scroll detection for scroll display method
Fixed
- Modal closing issues on mobile devices
- Race conditions in event firing
- CSS specificity issues with custom styles
API
Added
- Custom data support in acceptance records
- Enhanced verification endpoint with document-level details
- Better error responses with detailed error codes
Changed
- Improved API response times
- Better caching headers for packet data
- Enhanced rate limiting
Web Portal
Added
- Bulk document operations
- Advanced filtering options
- Team collaboration features
Changed
- Redesigned UI for better usability
- Improved performance for large datasets
- Better mobile responsiveness
Release 1.3.0 (Absecon)
Release Date: September 2023
JavaScript Library
Added
- Force scroll display method
- Manual acceptance mode
- Event listeners:
tc-valid,tc-accepted,tc-internal-error - Modal support for viewing document terms
- Customizable CSS classes
Changed
- Improved validation logic
- Better mobile support
- Enhanced accessibility features
Fixed
- Cross-browser compatibility issues
- Memory leaks in event listeners
- Validation edge cases
API
Added
- Verify endpoint for checking user compliance
- Better versioning support
- Enhanced security features
Changed
- Improved API documentation
- Better error messages
- Rate limiting adjustments
Web Portal
Added
- Document versioning UI
- Packet management interface
- Agreement search and filtering
- PDF download functionality
Release 1.2.0
Release Date: June 2023
JavaScript Library
Added
- Individual and group display methods
- Support for multiple documents per packet
- CDN distribution
- NPM package publication
Changed
- Simplified initialization process
- Improved documentation
- Better TypeScript support
Fixed
- Initial rendering issues
- Event timing bugs
- CSS conflicts with common frameworks
API
Added
- POST Accept endpoint
- GET Packet endpoint
- Client authentication system
Changed
- API base URL structure
- Response formats
- Authentication headers
Web Portal
Added
- Initial portal release
- Document management
- Client management
- Basic reporting
Release 1.1.0
Release Date: March 2023
JavaScript Library
Added
- Core library functionality
- Basic display options
- Simple checkbox rendering
Changed
- Library architecture improvements
- Better error handling
Fixed
- Critical bugs in acceptance flow
- Validation issues
Release 1.0.0
Release Date: January 2023
Initial release of ToughClicks platform.
Features
- JavaScript library for document acceptance
- REST API for programmatic access
- Web portal for management
- PDF record generation
- Basic versioning support
Deprecation Notices
Deprecated in 1.5.0
Agreement.Userfield - UseAgreement.SignerIdentifierandAgreement.SignerEmailAddressinstead
Planned Deprecations
None currently planned. We maintain strong backward compatibility commitments.
Upcoming Features
We're constantly working to improve ToughClicks. Upcoming features include:
- Enhanced analytics and reporting
- Webhook support for real-time notifications
- Advanced customization options
- Mobile SDKs (iOS and Android)
- GraphQL API
- Advanced document templating
- Multi-language support
For the latest updates and announcements, contact your account manager or check the Management Portal for release notes.
Version Support
We provide support for the following versions:
- Latest Version (2.4.0 / Hatteras) - Full support and active development
- Earlier 2.x Versions (2.0.0 Edisto, 2.1.x Fidalgo, 2.2.0 Galveston) - Full support and maintenance
- Stable Version (1.6.x / Dauphin) - Full support and maintenance
- Previous Version (1.5.x / Camano) - Security updates and critical bug fixes
- Older Versions (Beaver, Absecon) - Limited support, upgrade recommended
We recommend keeping your integration up to date with the latest version to benefit from new features, performance improvements, and security updates.
Breaking Changes
We strive to maintain backward compatibility, but occasionally breaking changes are necessary:
Version 2.0.0 (Edisto)
- None - Fully backward compatible with 1.6.x
Version 1.6.0 (Dauphin)
- None - Fully backward compatible with 1.5.x
Version 1.5.0 (Camano)
- None - Fully backward compatible with 1.4.x
Version 1.4.0 (Beaver)
- None - Fully backward compatible with 1.3.x
Need Help?
If you have questions about updates or need help upgrading, contact our technical support team.