• Documentation >
• Apps >
• Productivity >
• Helpwise

Helpwise

With Helpwise Sell modules in Ibexa Connect, 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.

Connect Helpwise to Ibexa Connect

To connect Helpwise app, you need to obtain the API Key and API Secret from your Helpwise account:

1. Log in to your Helpwise account.

2. Click Automation > API > Generate Credentials.

   

3. Copy the API Key and API Secret to a safe place.

   

4. In your Ibexa Connect account, insert a Helpwise module in your scenario and click the Add button next to the Connection field.

   

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

6. 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 scenarios

Mailboxes

You can watch, create, list, and retrieve the mailboxes using the following modules.

List Mailboxes

Lists your mailboxes from Helpwise.

Limit	Set the maximum number of mailboxes Ibexa Connect will return during one execution cycle.

Watch Mailboxes

Triggers when a new mailbox is added to your Helpwise.

Limit	Set the maximum number of mailboxes Ibexa Connect will return during one execution cycle.

Get a Mailbox

Returns information about a specific mailbox.

ID	Select or map the Mailbox ID whose details you want to retrieve.

Create a Mailbox

Creates a new mailbox.

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.

Threads

You can watch, list, and retrieve the threads using the following modules.

List Threads

Lists your threads/conversations from Helpwise.

Mailbox ID	Select or map the Mailbox ID whose details you want to retrieve.
Limit	Set the maximum number of threads Ibexa Connect will return during one execution cycle.

For field descriptions, see the Mailbox API reference.

Watch Threads

Triggers when a new thread/conversation is added to your mailbox.

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 Ibexa Connect will return during one execution cycle.

Get a Thread

Returns information about a specific thread/conversation.

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.

Emails

You can watch, list, and send an email using the following modules.

List Emails

Lists your emails from Helpwise.

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 Ibexa Connect will return during one execution cycle.

Watch Emails

Triggers when a new email is added to your mailbox.

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 Ibexa Connect will return during one execution cycle.

Send an Email

Creates and sends a new email.

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.

Notes

You can add a note using the following modules.

Add a Note

Creates a new note.

Mailbox ID	Select or map the Mailbox ID to which you want to add the note.

For field descriptions, see the Helpwise API reference.

Contacts

You can watch, create, list, retrieve and search the contacts using the following modules.

List Contacts

Returns data about your contacts from Helpwise

Limit	Set the maximum number of contacts Ibexa Connect will return during one execution cycle.

Watch Contacts

Triggers when a new contact is added.

Limit	Set the maximum number of contacts Ibexa Connect will return during one execution cycle.

Get a Contact

Returns information about a specific contact.

Contact's ID	Select or map the Contact ID whose details you want to retrieve.

Create a Contact

Creates a new contact.

For field descriptions, see the Helpwise API reference.

Search Contacts

Performs a search across all your contacts on Helpwise.

Limit	Set the maximum number of contacts Ibexa Connect will return during one execution cycle.

For field descriptions, see the Helpwise API reference.

Other

You can call APIs using the following module.

Note

For the list of available endpoints, refer to the Helpwise API documentation.

Make an API Call

Performs an arbitrary authorized API call.

URL	Enter a path relative to https://app.helpwise.io. For example, /dev-apis/contacts/list.
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.

Example of use - List Contacts

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 Bundle > Body > data > contacts.

In our example 6 contacts were returned: