| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your own connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…).. |
With Helpwise Sell modulesa module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. in Boost.spaceA platform that centralizes and synchronizes company data from internal and external sources, offering a suite of modules and addons for project management, CRM, data visualization, and more. Has many features to optimize your workflow! IntegratorPart of the Boost.space system, where you can create your connections and automate your processes., you can:
-
watch, create, list, and retrieve mailboxes
-
watch, list, and retrieve threads
-
watch, list, and send emails
-
add note
-
watch, create, list, retrieve and search contacts
To get started with Helpwise, create an account at helpwise.io.
To connect Helpwise app, you need to obtain the API Key and API Secret from your Helpwise account:
-
Log in to your Helpwise account.
-
Click Automation > API > Generate Credentials.
-
Copy the API Key and API Secret to a safe place.
-
In your Boost.space Integrator account, insert a Helpwise modulea module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. in your scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive. and click the Add button next to the Connection field.
-
In the Connection name field, enter a name for the connection.
-
In the Key and Secret fields, enter the details copied in step 3 and click Save.
You have successfully connected the Helpwise app and can now build scenariosA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive.
You can watch, create, list, and retrieve the mailboxes using the following modules.
Lists your mailboxes from Helpwise.
|
Connection |
|
|
Limit |
Set the maximum number of mailboxes Boost.space Integrator will return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
TriggersThe initial event that starts a scenario. It can be an action, a scheduled time, or a custom event, and is essential to define at the beginning of each scenario. when a new mailbox is added to your Helpwise.
|
Connection |
|
|
Limit |
Set the maximum number of mailboxes Boost.space Integrator will return during one execution cycle. |
Returns information about a specific mailbox.
|
Connection |
|
|
ID |
Select or map the Mailbox ID whose details you want to retrieve. |
Creates a new mailbox.
|
Connection |
|
|
Email address |
Enter the email address associated with the mailbox. |
|
Display Name |
Enter the mailbox name that appears on the mailbox. |
For field descriptions, see the Helpwise API reference.
You can watch, list, and retrieve the threads using the following modules.
Lists your threads/conversations from Helpwise.
|
Connection |
|
|
Mailbox ID |
Select or map the Mailbox ID whose details you want to retrieve. |
|
Limit |
Set the maximum number of threads Boost.space Integrator will return during one execution cycle. |
For field descriptions, see the Mailbox API reference.
Triggers when a new thread/conversation is added to your mailbox.
|
Connection |
|
|
Mailbox ID |
Select or map the Mailbox ID whose details you want to watch. |
|
Tag ID |
Select or map the Tag ID to watch the threads that match the specified tags. |
|
Query |
Enter a keyword or phrase to watch the threads that match the specified queries. |
|
Limit |
Set the maximum number of threads Boost.space Integrator will return during one execution cycle. |
Returns information about a specific thread/conversation.
|
Connection |
|
|
Mailbox ID |
Select or map the Mailbox ID whose thread you want to retrieve. |
|
Thread ID |
Enter the Thread ID whose details you want to retrieve. |
You can watch, list, and send an email using the following modules.
Lists your emails from Helpwise.
|
Connection |
|
|
Mailbox ID |
Select or map the Mailbox ID whose emails you want to list. |
|
Thread ID |
Enter the Thread ID whose emails you want to list. |
|
Limit |
Set the maximum number of emails Boost.space Integrator will return during one execution cycle. |
Triggers when a new email is added to your mailbox.
|
Connection |
|
|
Mailbox ID |
Select or map the Mailbox ID whose emails you want to watch. |
|
Thread ID |
Select or map the 8-digit number, that you can find in the URL. |
|
Limit |
Set the maximum number of emails Boost.space Integrator will return during one execution cycle. |
Creates and sends a new email.
|
Connection |
|
|
Mailbox ID |
Select or map the Mailbox ID from which you want to send an email. |
|
To |
Enter a comma-separated list of customer email addresses to which you want to send the email. |
|
CC |
Enter a comma-separated list of customer email addresses to which you want to add to the CC field of the email. |
|
Subject |
Enter the subject line for the email. |
|
Body |
Enter the body message of the email. |
You can add a note using the following modules.
Creates a new note.
|
Connection |
|
|
Mailbox ID |
Select or map the Mailbox ID to which you want to add the note. |
For field descriptions, see the Helpwise API reference.
You can watch, create, list, retrieve and search the contacts using the following modules.
Returns data about your contacts from Helpwise
|
Connection |
|
|
Limit |
Set the maximum number of contacts Boost.space Integrator will return during one execution cycle. |
Triggers when a new contact is added.
|
Connection |
|
|
Limit |
Set the maximum number of contacts Boost.space Integrator will return during one execution cycle. |
Returns information about a specific contact.
|
Connection |
|
|
Contact’s ID |
Select or map the Contact ID whose details you want to retrieve. |
Performs a search across all your contacts on Helpwise.
|
Connection |
|
|
Limit |
Set the maximum number of contacts Boost.space Integrator will return during one execution cycle. |
For field descriptions, see the Helpwise API reference.
You can call APIs using the following module.
![[Note]](https://docs.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/note.png) |
Note |
|---|---|
|
For the list of available endpoints, refer to the Helpwise API documentation. |
Performs an arbitrary authorized API call.
|
Connection |
|
|
URL |
Enter a path relative to |
|
Method |
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. |
The following API call returns all contacts from your account.
URL: /dev-apis/contacts/list
Method: POST
The search matches can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. > Body > data > contacts.
In our example 6 contacts were returned:
