Kiln Widget enables the activate of earn feature without requiring extensive technical resources. Whether you have a dedicated development team or not, you can integrate Kiln Widget with ease.
Last updated
Was this helpful?
You need a dashboard organization, if it's not already the case, ask kiln team so that we can onboard you.
You need access to a Kiln Connect API key, if it's not already the case, ask kiln team so that we can onboard you. You can generate one yourself, click here to read more.
Have some deployed products on mainnet, if it's not already the case, kiln can provide test product for your testing and trial integration.
Optional : have customize your widget, you can directly upload your configuration via API and soon in Kiln dashboard directly
Kiln provides a deeplink mechanism that allows seamless redirection into the different pages between overview, deposit and withdraw.
To enhance your platform's capabilities, consider integrating specific features of the Kiln Widget. For instance, if you already have an existing native earn section, you can redirect users to the Kiln Widget for deposit transactions. After a transaction is signed, seamlessly bring the user back to your platform.
Access your widget using the configured slug , this will automatically pull your configuration including theme and available earn products. In this document we refer to this as "base url" or "your widget".
Structure: https://slug.widget.kiln.fi/
Example: https://iframe.widget.testnet.kiln.fi/ , a Kiln managed configuration for testing the widget in an iframe.
By default if you redirect the user to "your widget" the overview page, it's will show all the user active and potential position based on the products you enabled in your widget.
To redirect the user to this page you need to add the /overview after your base URL.
Structure: https://slug.widget.kiln.fi/overview
By default if you redirect the user to "your widget" the overview page, it's will show all the user active and potential position based on the products you enabled in your widget.
To redirect the user to the manage page you need to add the /overview after your base URL.
Structure: https://slug.widget.kiln.fi/overview/{product}/{product_id}
product is define in the deployment endpoint and can be one of dedicated / pooling / defi
product_id valid vault ID in the format <chainId>_<vaultAddress>
eg. 1_0xd88714e295da03a07bcb8ad4a4dbe87fa42d75f9
Example opening a Morpho Vault:
If you want to open the widget direct on the deposit flow, you will need to add /earn after your base URL.
Structure: https://slug.widget.kiln.fi/earn
On this page, you can use the following path params to further customize the deposit flow.
Hereâs the improved Kiln Widget Deeplink Integration Guide with a clearer query parameters table, better type definitions, select options, detailed descriptions, and examples.
select_deployment
"disabled" or unspecified
Controls whether users can select a deployment. If "disabled", the deployment selection is locked.
select_deployment=disabled
select_asset
"disabled" or unspecified
Controls whether users can select an asset. If "disabled", the asset selection is locked.
select_asset=disabled
product_id
Valid product ID in the format <chainId>_<vaultAddress>
Predefines the deployment to use.
deployment_id=1_0xabc123456789...
asset_id
Valid asset ID in the format <chainId>_<assetAddress>
Predefines the asset to deposit.
asset_id=1_0xdef456789abc...
callback_title
Any string
The text displayed on the return button after deposit.
callback_title=Back+to+Dashboard
callback_url
Valid HTTPS URL
The URL where the user is redirected after deposit completion.
callback_url=https://yourapp.com/dashboard
Example Deeplinks
Users can freely choose deployment and asset:
Locking a specific vault and asset:
Prevent users from changing the predefined values:
Automatically send users back to your app after completing the deposit using callback_url :
If you want to open the widget direct on the withdraw flow, you will need to add /withdraw after your base URL.
Structure: https://slug.widget.kiln.fi/withdraw
You can use the path parameters defined above, notably : product_id , callback_title , callback_url .
