| 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…). More. |
The HappyFox Chat 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 allow you to monitor the offline, missed and finished chats in your HappyFox Chat account.
Prerequisites
-
A HappyFox Chat account – create an account at happyfox.com/live-chat/.
![[Note]](https://docs.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/note.png) |
Note |
|---|---|
|
The 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 dialog fields that are displayed in bold (in the 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 scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive. More, not in this documentation article) are mandatory! |
To connect your HappyFox Chat account to Boost.space Integrator you need to API Key from your HappyFox Chat account and insert it in the Create a connection dialog in the Boost.space Integrator module.
1. Log in to your HappyFox Chat account.
2. Click the top menu drop-down >Apps > REST API > Manage.
3. Copy the API key to your clipboard.
4. Go to Boost.space Integrator and open the Happyfox Chat module’s Create a connection dialog.
5. In the Connection name field, enter a name for the connection.
6. In the API TokenThe API token is a multi-digit code that allows a user to authenticate with cloud applications. More field, enter the tokenThe API token is a multi-digit code that allows a user to authenticate with cloud applications. More copied in step 3, and click Continue.
The connection has been established.
|
Note |
|---|---|
|
Happyfox Chat allows only one instant webhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. at a time, to watch all types of events, set up a custom webhook module. |
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... when a chat conversation ends or no agents pick up an incoming chat request.
|
Webhook Name |
Enter a name for the webhook. |
|
Connection |
Triggers when a visitor leaves a message when all agents are offline.
See Setting Up HappyFox Chat Webhooks to add webhook in your HappyFox Chat account.
Performs an arbitrary authorized API call.
|
Connection |
||||
|
URL |
Enter a path relative to
|
|||
|
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. |
The following API call returns all the profiles from your HappyFox Chat account:
URL: /v1/profiles
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 > data. In our example, 9 profiles were returned:
1. In your Boost.space Integrator account, open any Watch module, establish a connection, click Save and copy the URL address to your clipboard. Click OK and save the triggerEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the....
2. Log in to your HappyFox Chat account.
3. Click Apps > WebhooksA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers..
4. Add the URL address copied in step 1 and click Save.
You have successfully added the webhook.
