This feature allows you to create an application inline by using a simple web URL. This can be useful in scenarios like embedding Clustdoc applications in an iframe on external websites, for example.
How does it work ?
Let's say you want to create an application for John Doe (jdoe@gmail.com). First you need to find the ID of the process you would like to use.
Once you have grabbed that ID, just paste the following link in your browser:
https://app.clustdoc.com/misc-api/inline-dossier/xxxxxx?firstnameJohn&lastname=Doe&email=jdoe@gmail.com
OR if you want to embed the page in an Iframe:
<iframe src="https://app.clustdoc.com/misc-api/inline-dossier/xxxxxx?firstnameJohn&lastname=Doe&email=jdoe@gmail.com">
⚠️Then replace xxxxxx with your own Process ID
This URL will create a new application for John Doe and redirect the user to that application portal.
Optional parameters
First name, last name and email parameters are mandatory. You can also add some additional parameters to the url in order to customize the user experience.
Please find below the list of those parameters.
| Parameter = value | Explanation |
|---|---|
|
embedded=1: embedded experience embedded=0: full page experience (default) |
1: Use this if you're embedding Clustdoc in an external website |
|
with_logo=1: keep the logo (default) with_logo=0: remove the logo |
0: Add this if you want to hide the logo on the page (it will keep other user information) |
|
with_header=1: keep the header (default) with_header=0: remove the header |
0: Remove the header from the client page |
|
create_if_missing=1: check existing application create_if_missing=0: create in any case (default) |
1: If there's an existing application with the provided email address, the user will be redirected to that application. Otherwise, a new application is created. |
|
notify_recipient=1: notify recipient (default) notify_recipient=0: do not notify |
0: Do not notify the recipient (email automation) |
E.g. https://app.clustdoc.com/misc-api/inline-dossier/xxxxxx?firstnameJohn&lastname=Doe&email=jdoe@gmail.com&embedded=1&create_if_missing=1
Tips
If you're building an embedded solution, don't forget to remove the password protection on your process if you want to avoid double authentication on your site and on Clustdoc
Use create_if_missing parameter if you want to avoid multiple application for the same user
Comments
0 comments
Article is closed for comments.