Articles on: Badges & Widgets

How To Add Widgets Using The Widget API

1. You'll First Want To Start By Creating A Widget API Key:



You can find your API keys in your Account under the API Keys tab. Click on the 'Create API Key' button to start.



Name your API key and choose 'Widget API' as the type, then click on the 'Create API Key' button to generate your key.






Copy your API key and embed it into your application to fetch Widgets. Your API key is only shown to you once so you can't view it after you close this dialog, but you can always create a new one if needed.




2. From Here You Can Use Our Widget API Documentation To Start Building The Correct Endpoint For Your Site.



Below is a list of our widgets, linked to their API documentation where you can fetch and display all of our Widgets easily. This will require some custom coding and so we highly suggest the support of a developer when inputting a badge using the Widget API.

You can find out how to embed each badge with our API documentation below:



Spend Level Widgets

Per Order Widget

By Percentage Widget

Tiered Spend Level Widget

Per Product Widget

Cart Widget

Top Stats Widget

Full Width Banner

Updated on: 16/10/2024

Was this article helpful?

Share your feedback

Cancel

Thank you!