Fleep¶
The Fleep modules allow you to watch the create, update, search, and delete the messages in your Fleep account.
Getting Started with Fleep¶
Prerequisites
- A Fleep account
In order to use Fleep with Ibexa Connect, it is necessary to have a Fleep account. If you do not have one, you can create a Fleep account at fleep.io/register.
Connecting Fleep to Ibexa Connect¶
1. Go to Ibexa Connect and open the Fleep module's Create a connection dialog.
2. In the Connection name field, enter a name for the connection.
3. In the Email and Password fields, enter your Fleep account credentials, and click Continue.
The connection has been established.
Messages¶
Search Messages¶
Searches messages.
| Keywords | Enter the keywords to search the messages with the specified words. |
| Search Type | Select the filter based on which you want to search the messages. For example, task, chat, topic, and so on. |
Create a Message¶
Sends a new message to a selected Fleep conversation.
| Conversation ID | Select the Conversation ID for which you want to create the message. |
| Message | Enter the message text. |
Update a Message¶
Updates a message.
| Conversation ID | Select the Conversation ID whose message details you want to update. |
| Message | Enter the message text with which you want to update the existing message. |
| Message Number | Enter the message number of the reference message. |
Delete a Message¶
Deletes a message.
| Conversation ID | Select the Conversation ID whose message details you want to delete. |
| Message Number | Enter the Message Number of the reference message you want to delete. |
Other¶
Make an API Call¶
Performs an arbitrary authorized API call.
URL |
Enter a path relative to For the list of available endpoints, refer to the Fleep 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 Messages¶
The following API call returns all the messages details from your Fleep account:
URL:
/search
Method:
POST
Body:
{"keyword": "s"}
Matches of the search can be found in the module's Output under Bundle > Body > matches.
In our example, 3 messages were returned:
