The Fluid APIs provides a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. This bundle offers robust functionality for enhancing messaging solutions, streamlining data management, and improving customer interactions. With detailed documentation, secure authentication, and flexible integration options, the Fluid Public API Bundle is engineered to help you leverage our services efficiently and effectively, unlocking new potentials and achieving greater connectivity within your systems.
Carts api that can be used for api call by webhooks of external applications or admins.
Operations
CatchUps
Catchup is a unique feature in our mobile app designed to keep you informed about everything you might have missed while you were away. From unread messages to visitor activities, it ensures you stay up-to-date with all the important details.
Operations
Categories
Categories
Operations
Collections
Products can be organized under a collection or multiple collections.
Operations
Contacts
Manage contacts
Operations
Conversations
Conversations within Fluid's platform serve as the central hub where users, contacts and/or automated agents (such as Response Bots and Broadcast Bots) come together to exchange messages. Each conversation can include multiple participants, ranging from individual users to bots designed to provide interactive support or broadcast important updates. With a flexible architecture, Conversations allow for rich interactions, whether it’s real-time messaging, automated responses, or large-scale broadcasts.
The structure supports seamless communication, enabling participants to share information effectively while allowing developers to build and extend features like bots that can respond, broadcast, or even act as virtual assistants within any conversation.
Operations
Custom Pages
Create and manage custom pages within the application. Custom pages allow you to build unique, branded experiences and content areas tailored to your needs.
Operations
Events
Manage and track system events that occur within the application. Events provide a way to monitor and respond to various activities and state changes.
Operations
Create Company Event
Request
Add a new event for the company with details like title, dates, location, and optional media content.
Bodyapplication/jsonrequired
eventobject(Event3)required
Example: {"title":"Type Race","description":"Fluid Type Racing Game. Winner gets all expenses paid 1 month vacation trip to Bali.","start_date":"2024-03-28","end_date":"2024-04-01","start_time":"9:56:0","end_time":"19:56:0","time_zone":"Asia/Kathmandu","url":"https://google.com","active":true,"venue":"Pokhara","available_countries":["us","in","fin"],"images_attributes":[{"image_url":"https://images.furnituredealer.net/img/products/liberty_furniture/color/double%20bridge--816253672_152-cd-gts-b6.jpg","position":1},{"image_url":"https://images.furnituredealer.net/img/products/steve_silver/color/david-1172854226_di100c-b1.jpg"}]}
event.titlestringrequired
Example: "Type Race"
event.descriptionstringrequired
Example: "Fluid Type Racing Game. Winner gets all expenses paid 1 month vacation trip to Bali."
event.start_datestringrequired
Example: "2024-03-28"
event.end_datestringrequired
Example: "2024-04-01"
event.start_timestringrequired
Example: "9:56:0"
event.end_timestringrequired
Example: "19:56:0"
event.time_zonestringrequired
Example: "Asia/Kathmandu"
event.urlstringrequired
Example: "https://google.com"
event.activebooleanrequired
Example: true
event.venuestringrequired
Example: "Pokhara"
event.available_countriesArray of stringsrequired
Example: ["us","in","fin"]
event.images_attributesArray of objects(ImagesAttribute)required
Retrieves a list of events associated with the company.
Mock server https://docs.fluid.app/_mock/docs/apis/fluid.api/company/events
Production server with company subdomain https://myco.fluid.app/api/company/events
Local development server http://fluid.lvh.me:3000/api/company/events
curl
JavaScript
Node.js
Python
Java
C#
PHP
Go
Ruby
R
Payload
curl-i-X GET \
https://docs.fluid.app/_mock/docs/apis/fluid.api/company/events \-H'Authorization: Bearer <YOUR_TOKEN_HERE>'
Responses
Headers
Content-Typestring
The content type of the response
Example: "application/json"
Content-Lengthstring
The length of the response content in bytes
Example: "981"
X-Request-Idstring
A unique identifier for the request
Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Update Company Event
Request
Updates the details of a specific company event
Path
eventIdintegerrequired
The unique identifier of the event to update
Bodyapplication/jsonrequired
eventobject(Event4)required
Example: {"title":"Type Race","description":"Fluid Type Racing Game. Winner gets all expense paid 1 month vacation trip to Bali. The winner will also get the salary/wages for the vacation month.","available_countries":["npl","us"]}
event.titlestringrequired
Example: "Type Race"
event.descriptionstringrequired
Example: "Fluid Type Racing Game. Winner gets all expense paid 1 month vacation trip to Bali. The winner will also get the salary/wages for the vacation month."
event.available_countriesArray of stringsrequired
Example: ["npl","us"]
Mock server https://docs.fluid.app/_mock/docs/apis/fluid.api/company/events/{eventId}
Production server with company subdomain https://myco.fluid.app/api/company/events/{eventId}
Local development server http://fluid.lvh.me:3000/api/company/events/{eventId}
curl
JavaScript
Node.js
Python
Java
C#
PHP
Go
Ruby
R
Payload
curl-i-X PATCH \'https://docs.fluid.app/_mock/docs/apis/fluid.api/company/events/{eventId}'\-H'Authorization: Bearer <YOUR_TOKEN_HERE>'\-H'Content-Type: application/json'\-d'{
"event": {
"title": "Type Race",
"description": "Fluid Type Racing Game. Winner gets all expense paid 1 month vacation trip to Bali. The winner will also get the salary/wages for the vacation month.",
"available_countries": [
"npl",
"us"
]
}
}'
Responses
Headers
Content-Typestring
The content type of the response
Example: "application/json"
Content-Lengthstring
The length of the response content in bytes
Example: "981"
X-Request-Idstring
A unique identifier for the request
Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Get Company Event Details
Request
Retrieves the details of a specific event for a company.
Path
eventIdintegerrequired
The unique identifier of the company event
Mock server https://docs.fluid.app/_mock/docs/apis/fluid.api/company/events/{eventId}
Production server with company subdomain https://myco.fluid.app/api/company/events/{eventId}
Local development server http://fluid.lvh.me:3000/api/company/events/{eventId}
curl
JavaScript
Node.js
Python
Java
C#
PHP
Go
Ruby
R
Payload
curl-i-X GET \'https://docs.fluid.app/_mock/docs/apis/fluid.api/company/events/{eventId}'\-H'Authorization: Bearer <YOUR_TOKEN_HERE>'
Responses
Headers
Content-Typestring
The content type of the response
Example: "application/json"
Content-Lengthstring
The length of the response content in bytes
Example: "981"
X-Request-Idstring
A unique identifier for the request
Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Delete Company Event
Request
Deletes a specific event associated with the company.
Path
eventIdintegerrequired
The unique identifier of the event to delete
Mock server https://docs.fluid.app/_mock/docs/apis/fluid.api/company/events/{eventId}
Production server with company subdomain https://myco.fluid.app/api/company/events/{eventId}
Local development server http://fluid.lvh.me:3000/api/company/events/{eventId}
Sends notifications about an event to concerned parties based on specified countries.
Path
eventIdintegerrequired
The unique identifier of the event to send notifications for
Mock server https://docs.fluid.app/_mock/docs/apis/fluid.api/company/events/{eventId}/send_notifications
Production server with company subdomain https://myco.fluid.app/api/company/events/{eventId}/send_notifications
Local development server http://fluid.lvh.me:3000/api/company/events/{eventId}/send_notifications
curl
JavaScript
Node.js
Python
Java
C#
PHP
Go
Ruby
R
Payload
curl-i-X GET \'https://docs.fluid.app/_mock/docs/apis/fluid.api/company/events/{eventId}/send_notifications'\-H'Authorization: Bearer <YOUR_TOKEN_HERE>'
Responses
Headers
Content-Typestring
The content type of the response
Example: "application/json"
Content-Lengthstring
The length of the response content in bytes
Example: "981"
X-Request-Idstring
A unique identifier for the request
Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Libraries
Manage reusable components and resources that can be shared across your application. Libraries help maintain consistency and reduce duplication in your implementation.
Operations
Media
Handle media assets such as images, videos, and documents that are used throughout the application. Includes functionality for upload, storage, and delivery of media content.
Operations
Messages
Messages are the core units of communication within Fluid’s platform, facilitating interactions between participants in a conversation. Each message can originate from either a user or a contact or an automated bot, allowing for dynamic exchanges ranging from simple text messages to more complex data payloads.
Messages support various use cases, whether it's delivering personalized responses via Response Bots, broadcasting announcements from Broadcast Bots, or regular user-to-user communication. The flexible structure of messages ensures that they can be tailored to suit different needs, providing a robust foundation for real-time interaction, automation, and seamless integration within the broader conversation framework.
Operations
Orders
Manage company orders using API endpoints.
Operations
Points
Manage points
Operations
ProductRedirects
Handle product URL redirects to maintain SEO value and ensure proper routing when product URLs change or products are moved within your catalog.
Operations
Products
Product API that can be used by external applications or admins.
Operations
Recipients
Manage Users for the company. Using this api you can list, create, update and delete the users for the company.
Operations
Social Media
Social Media is used to store the username for the companies various social media accounts.
Tiles
Tiles are a crucial feature in our admin portal, designed to facilitate Single Sign On (SSO) flows for users within the app. Each Tile represents a redirecting button within the user's app that links to a specific URL, with the addition of a temporary authorization token (auth_token) as a parameter.
Here's how the process works:
In the admin portal, a new Tile is created. Each Tile is essentially a shortcut to a specific URL, such as https://www.example.com.
The Tile appears in the user's app interface as a button, featuring a representative image. This makes it easy for users to identify and access.
When an authorized User clicks on the Tile in app, an authorization token (auth_token) is generated and appended to the URL as a parameter. For example, https://www.example.com?auth_token=ABC123.
When the user clicks on the Tile (button), they are automatically redirected to the URL embedded in the Tile, carrying the auth_token along.
The user's browser then visits the URL, and the auth_token is passed to the link.
The User Show API endpoint accepts the auth_token to fetch the user's details. This data can be utilized to automatically sign the user into their account, eliminating the need for manual login. Alternatively, it can be used to generate an app-in-an-app experience where the user navigates within a portion of your app as an authenticated user.
This Tile functionality streamlines the user experience, granting a smoother navigation process and easing user access with a Single Sign On (SSO) flow.
Note: auth_token expires after 30 minutes.
Operations
Users
Manage Users for the company. Using this api you can list, create, update and delete the users for the company.
Operations
Variants
Manage product variants including different sizes, colors, or other attributes that define unique versions of a product.
Operations
Webhooks
Webhook Events are generated by some Fluid resources when certain actions are completed, such as the creation of an order, abandonment of cart, or the deactivation of an user. By requesting events, your app can know when certain actions have occurred in the fluid.
Social Media
Social Media is used to store the username for the companies various social media accounts.