Get Started
Connecting your Store #
The first step of installing Clerk.io is connecting your Umbraco store to your Clerk.io account.
After following these simple steps, you will be able to see your Live Demo Store, which gives you a personal overview of how Clerk.io will work on your webshop.
1. Add Store #
Log in to my.clerk.io. The first time you do this, you will see the Add New Store page.
Enter the Name and Domain of your webshop
Choose Other as the Platform and select your Currency
Click Add Store

2. Configure Connector #
Install the Clerk.io connector in Umbraco
In the top menu, select Clerk.io
Insert the Public API Key (found in Clerk.io under Settings -> API keys) in Umbraco backoffice > Clerk.io > Clerk.io API Configuration as shown in the image below:

- Check the Feed Configuration and select the appropriate Document Type that represents the products, categories, and content pages to be shared with Clerk.io.
For individual data, map Clerk.io properties to corresponding Umbraco properties. This includes fields such as product name, description, price, and other relevant details.
- Click Save Configuration

3. Configure Feed #
Log in to my.clerk.io
Navigate to System Status > Data sync
Choose Sync Method, selecting Clerk.io JSON Feed v2
Fill out the information: A set of fields will be displayed, including “JSON Product URL”, “JSON Categories URL”, “JSON Orders URL” and others. Refer to the screenshot below for guidance.
- JSON Product URL - {your site url}/clerk/products.json
- JSON Category URL - {your site url}/clerk/categories.json
- JSON Orders URL - {your site url}/clerk/orders.json
- JSON Customers URL - {your site url}/clerk/customers.json
- JSON Pages URL - {your site url}/clerk/pages.json

Audit Data Tracking #
Admin users can easily monitor the data shared with Clerk.io through the package’s intuitive interface.
The system provides detailed logs, including timestamps and specific paths, ensuring transparency and accountability in the data-sharing process.
