Marketing

Clust

16min
get started with clust the clust modules allow you to create, watch, update, and delete application in your clust account prerequisites a clust account in order to use clust with make, it is necessary to have a clust account if you do not have one, you can create a clust account at clustdoc com/register connect clust to make to connect your clust account to make you need to obtain the api key from your clust account and insert it in the create a connection dialog in the make module log in to your clust account click profile icon > set up team > developers > api integrations section in the token name field, enter a name for the token and select the permissions for the token click create copy the api token to your clipboard go to make and open the clust module's create a connection dialog in the connection name field, enter a name for the connection in your clust api key field, enter the api key copied in step 4 and click continue the connection has been established clust modules application watch application created triggers when a new application is created field description connection establish a connection to your clust account limit enter the maximum number of applications make should return during one make execution cycle watch application late triggers when a new application is late field description connection establish a connection to your clust account limit enter the maximum number of applications make should return during one make execution cycle watch application submitted triggers when a new application is submitted field description connection establish a connection to your clust account limit enter the maximum number of applications make should return during one make execution cycle watch application pending submission triggers when a new application pending submission is detected (all mandatory documents provided but the application not submitted) field description connection establish a connection to your clust account limit enter the maximum number of applications make should return during one make execution cycle watch application approved triggers when a new application is approved field description connection establish a connection to your clust account limit enter the maximum number of applications make should return during one make execution cycle get an application gets an application by id field description connection establish a connection to your clust account application id select the application id whose details you want to retrieve create an application creates an application by id field description connection establish a connection to your clust account template id select the template id appropriate for the application you want to create or select create a new template to create a new template for the application first name enter the recipient's first name last name enter the recipient's last name email enter the recipient's email address phone enter the recipient's phone number title enter the name of the application external id any internal reference to the application auto emails select 1 to send auto emails to the recipient for any updates or changes to the application select 0 to send email to the recipient manually folder id enter the folder id where the application is saved custom add any additional information about the recipient this information is not visible to the recipient url enter the webhook url to integrate events select the events for the application even new upload event application completed update an application updates an application by id field description connection establish a connection to your clust account application id select the application id you want to update template id select the template id appropriate for the application you want to create or select create a new template to create a new template for the application first name enter the recipient's first name last name enter the recipient's last name email enter the recipient's email address phone enter the recipient's phone number title enter the name of the application external id any internal reference to the application auto emails select 1 to send auto emails to the recipient for any updates or changes to the application select 0 to send email to the recipient manually folder id enter the folder id where the application is saved custom add any additional information about the recipient this information is not visible to the recipient url enter the webhook url to integrate events select the events for the application even new upload event application completed delete an application deletes an application by id field description connection establish a connection to your clust account application id select the application id you want to delete list applications lists all applications field description connection establish a connection to your clust account limit enter the maximum number of applications make should return during one make execution cycle other make an api call performs an arbitrary authorized api call field description connection establish a connection to your clust account url enter a path relative to https //api clustdoc com/ for example /dossiers method select the http method you want to use get to retrieve information for an entry post to create a new entry put to update/replace an existing entry patch to make a partial entry update delete to delete an entry headers enter the desired request headers you don't have to add authorization headers; we already did that for you query string enter the request query string body enter the body content for your api call example of use list applications the following api call returns all tasks from your clust account url /dossiers method get matches of the search can be found in the module's output under bundle > body > data in our example, 3 applications were returned for the list of available endpoints, refer to the clust api documentation https //sandbox clustdoc com/api reference