| Active |
|---|
| This application does not need additional settings. So you can make connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). More only by using your login credentials or by following the instructions below . |
With SupportBee modulesThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) More in Boost.spaceCentralization and synchronization platform, where you can organize and manage your data. More IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. More, you can:
-
watch, search, fetch, create, retrieve, trash, untrash, and delete tickets
-
watch new agents and customer replies
-
watch new comments
To get started with SupportBee, create an account at supportbee.com.
To connect SupportBee app, you need to obtain the Domain and API Key values from your SupportBee account and insert them into the SupportBee moduleThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) More scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive. More.
-
Log in to your SupportBee account.
-
Click Profile > API TokenThe API token is a multi-digit code that allows a user to authenticate with cloud applications. More. Copy the API TokenThe API token is a multi-digit code that allows a user to authenticate with cloud applications. More to a safe place.
-
Log in to your Boost.space Integrator account, insert a SupportBee module scenario and click the Add button next to the Connection field.
-
In the Connection name field, enter a name for the connection.
-
In the Domain field, enter your account domain. For example, if your account URL address is
https://www.xyz.supportbee.com, then your domain isxyz. -
In the API Key field, enter the details copied in step 2 and click Save.
You have successfully established the connection. You can now begin editing your scenario and adding more SupportBee modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.
You can watch, search, fetch, create, retrieve, trash, untrash, and delete tickets using the following modules.
Watches for a new ticket
|
WebhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. name |
Enter a name for the webhook. |
See Setting Up Supportbee Webhooks to add webhooksA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. in your Supportbee account.
Searches from all tickets.
|
Connection |
|
|
Limit |
Set the maximum number of tickets 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).. The default value is 10. |
See the SupportBee Tickets API reference for entering the field values to search for the tickets that match the specified value.
Fetches tickets.
|
Connection |
|
|
Limit |
Set the maximum number of tickets Boost.space Integrator will return during one execution cycle. The default value is 10. |
For field descriptions, see the SupportBee Tickets API reference.
Creates a ticket.
For field descriptions, see the SupportBee Tickets API reference.
Gets a ticket.
|
Connection |
|
|
Ticket ID |
Select or map the Ticket ID whose details you want to retrieve. |
Trashes a ticket.
|
Connection |
|
|
Ticket ID |
Select or map the Ticket ID you want to trash. |
Un-trashes a ticket.
|
Connection |
|
|
Ticket ID |
Select or map the Ticket ID you want to un-trash. |
Deletes a trashed ticket.
|
Connection |
|
|
Ticket ID |
Select or map the trashed Ticket ID you want to delete. |
You can watch new agents and customer replies using the following modules.
See Setting Up Supportbee Webhooks to add webhooks in your Supportbee account.
You can watch new comments using the following modules.
Watches for a new comment.
|
Webhook name |
Enter a name for the webhook. |
See Setting Up Supportbee Webhooks to add webhooks in your Supportbee account.
You can call APIs using the following module.
Performs an arbitrary authorized API call.
![[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 SupportBee API documentation. |
|
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 fetches tickets from your account.
URL: /tickets
Method: GET
Matches of the search 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. More > Body > tickets.
In our example 10 tickets were returned:
To set up the supportbee webhooks:
-
Open any Watch module, enter a name for the webhook, click Save and copy the URL address to your clipboard.
-
Log in to your Supportbee account, and click AdminAdmins in Boost.space have exclusive access to system settings. They manage the overall system setup, including appearance, language, currency, user settings, and the availability of individual modules to users and teams. More > Web Hooks.
-
In the URL field, enter the URL address copied in step 1 and click Add Integration.
