events

Fluid SDK API Documentation (0.0.6)

OpenAPI documentation for Fluid's SDK API

Download OpenAPI description
public.json
public.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/public/
Production API server
https://api.fluid.app/
Local development server
https://api.fluid.test/

Orders

Operations

carts

Operations

checkout

Operations

events

Operations

Save a new lead capture

Request

Bodyapplication/json
leadLeadEmail (object) or LeadPhone (object)(Lead)required
Any of:
lead.​namestringrequired
Example: "John Doe"
lead.​emailstring(email)required
Example: "john@example.com"
lead.​phonestring(phone)
Example: "+1 (800) 555-1234"
lead.​questionstringrequired
Example: "How are you?"
pageobject(Page)
metadataobject(RequestMetadata)required
metadata.​fluid_shopstringrequired
Example: "myshop"
metadata.​fluid_sessionstring(/\Afs_[0-9A-Za-z&&[^0OIl]]{22}\z/)required
Example: "fs_szwdDuRbqEe7AV7sXk7vVq"
metadata.​attributionAttributionLookupEmail (object) or AttributionLookupUsername (object) or AttributionLookupSharedGuid (object) or AttributionLookupFluidRepId (object) or AttributionLookupExternalId (object)(AttributionLookup)
Any of:
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/public/api/public/v2025-06/events/leads/capture \
  -H 'Content-Type: application/json' \
  -d '{
    "lead": {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "+1 (800) 555-1234",
      "question": "How are you?"
    },
    "page": {
      "url": "https://www.example.com/page",
      "title": "Example Page",
      "description": "This is an example page",
      "image": "https://www.example.com/page.jpg"
    },
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

lead captured

Bodyapplication/json
statusnumberrequired
Example: 201
metadataobject(ResponseMetadata)required
Example: {"fluid_shop":"myshop","fluid_session":"fs_szwdDuRbqEe7AV7sXk7vVq","request_uuid":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-01-01T00:00:00Z"}
metadata.​fluid_shopstringrequired
Example: "myshop"
metadata.​fluid_sessionstringrequired
Example: "fs_szwdDuRbqEe7AV7sXk7vVq"
metadata.​request_uuidstring(uuid)required
Example: "123e4567-e89b-12d3-a456-426614174000"
metadata.​timestampstringrequired
Example: "2025-01-01T00:00:00Z"
Response
application/json
{
  "status": 201,
  "metadata": {
    "fluid_shop": "string",
    "fluid_session": "string",
    "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8",
    "timestamp": "string"
  }
}

Save a new page visit

Request

Bodyapplication/json
pageobject(Page)required
page.​urlstring(uri)required
Example: "https://www.example.com/page"
page.​titlestring
Example: "Example Page"
page.​descriptionstring
Example: "This is an example page"
page.​imagestring(uri)
Example: "https://www.example.com/page.jpg"
metadataobject(RequestMetadata)required
metadata.​fluid_shopstringrequired
Example: "myshop"
metadata.​fluid_sessionstring(/\Afs_[0-9A-Za-z&&[^0OIl]]{22}\z/)required
Example: "fs_szwdDuRbqEe7AV7sXk7vVq"
metadata.​attributionAttributionLookupEmail (object) or AttributionLookupUsername (object) or AttributionLookupSharedGuid (object) or AttributionLookupFluidRepId (object) or AttributionLookupExternalId (object)(AttributionLookup)
Any of:
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/public/api/public/v2025-06/events/pages/visit \
  -H 'Content-Type: application/json' \
  -d '{
    "page": {
      "url": "https://www.example.com/page",
      "title": "Example Page",
      "description": "This is an example page",
      "image": "https://www.example.com/page.jpg"
    },
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

page visited

Bodyapplication/json
statusnumberrequired
Example: 201
metadataobject(ResponseMetadata)required
Example: {"fluid_shop":"myshop","fluid_session":"fs_szwdDuRbqEe7AV7sXk7vVq","request_uuid":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-01-01T00:00:00Z"}
metadata.​fluid_shopstringrequired
Example: "myshop"
metadata.​fluid_sessionstringrequired
Example: "fs_szwdDuRbqEe7AV7sXk7vVq"
metadata.​request_uuidstring(uuid)required
Example: "123e4567-e89b-12d3-a456-426614174000"
metadata.​timestampstringrequired
Example: "2025-01-01T00:00:00Z"
Response
application/json
{
  "status": 201,
  "metadata": {
    "fluid_shop": "string",
    "fluid_session": "string",
    "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8",
    "timestamp": "string"
  }
}

lead

Operations

page

Operations

fingerprint

Operations

session

Operations