• Documentation >
• Apps >
• Marketing >
• Clust

Clust

Getting 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 Ibexa Connect, it is necessary to have a Clust account. If you do not have one, you can create a Clust account at clustdoc.com/register.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting Clust to Ibexa Connect

To connect your Clust account to Ibexa Connect you need to obtain the API Key from your Clust account and insert it in the Create a connection dialog in the Ibexa Connect module.

1. Log in to your Clust account.

2. Click Profile Icon > Set up Team > Developers > API Integrations section.

   

3. In the Token Name field, enter a name for the token and select the permissions for the token. Click Create.

   

4. Copy the API token to your clipboard.

   

5. Go to Ibexa Connect and open the Clust module's Create a connection dialog.

   

6. In the Connection name field, enter a name for the connection.

7. In Your Clust API Key field, enter the API key copied in step 4 and click Continue.

   

The connection has been established.

Application

Watch Application Created

Triggers when a new application is created.

Limit	Enter the maximum number of applications Ibexa Connect should return during one scenario execution cycle.

Watch Application Late

Triggers when a new application is late.

Limit	Enter the maximum number of applications Ibexa Connect should return during one scenario execution cycle.

Watch Application Submitted

Triggers when a new application is submitted.

Limit	Enter the maximum number of applications Ibexa Connect should return during one scenario execution cycle.

Watch Application Pending Submission

Triggers when a new application pending submission is detected (all mandatory documents provided but the application not submitted).

Limit	Enter the maximum number of applications Ibexa Connect should return during one scenario execution cycle.

Watch Application Approved

Triggers when a new application is approved.

Limit	Enter the maximum number of applications Ibexa Connect should return during one scenario execution cycle.

Get an Application

Gets an application by ID.

Application ID	Select the Application ID whose details you want to retrieve.

Create an Application

Creates an application by ID.

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.

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.

Application ID	Select the Application ID you want to delete.

List Applications

Lists all applications.

Limit	Enter the maximum number of applications Ibexa Connect should return during one scenario execution cycle.

Other

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.clustdoc.com/. For example: /dossiers

For the list of available endpoints, refer to the Clust API Documentation.

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: