Webhooks
/
Get webhook resource payload examples

Fluid Commerce APIs (1.0)

The Fluid Commerce 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.

Download OpenAPI description
swagger.json
swagger.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/swagger/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Agreements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Droplets

Operations

Company Pages

Operations

Company Popups

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Social Media

Operations

Company Settings - Warehouses

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

Fluid Pay

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Order Fulfillments

Operations

Orders

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Public Companies

Operations

Redirects

Operations

Refunds

Operations

Roles

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Webhooks

Operations

Bulk delete webhooks

Request

Bodyapplication/json
webhook_idsArray of integersrequired

Array of webhook IDs to delete

Example: [1,2,3]
curl -i -X DELETE \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/company/webhooks/bulk_delete \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "webhook_ids": [
      1,
      2,
      3
    ]
  }'

Responses

success

Bodyapplication/json
webhook_idsArray of objects
Example: [{"id":1},{"id":2},{"id":3}]
metaobject
Example: {"request_id":"f5473a8c-8a86-4e0e-b3e8-95392003921b","timestamp":"2024-12-10T08:04:10Z"}
Response
application/json
{
  "webhook_ids": [
    { … },
    { … },
    { … }
  ],
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

List all webhooks

Request

Query
pageinteger

Page number

page_sizeinteger

Number of items per page

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/webhooks?page=0&page_size=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

webhooks found

Bodyapplication/jsonArray [
idinteger
company_idinteger
resourcestring
urlstring
activeboolean
auth_tokenstring or null
eventstring
http_methodstring
event_identifierstring
]
Response
application/json
[
  {
    "id": 0,
    "company_id": 0,
    "resource": "string",
    "url": "string",
    "active": true,
    "auth_token": "string",
    "event": "string",
    "http_method": "string",
    "event_identifier": "string"
  }
]

Create a webhook

Request

Bodyapplication/json
webhookobject
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/company/webhooks \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "webhook": {
      "resource": "cart",
      "url": "https://api.example.com/webhook",
      "active": true,
      "auth_token": "secret_token",
      "event": "update_cart_email",
      "http_method": "POST"
    }
  }'

Responses

webhook created

Retrieve a webhook

Request

Path
idintegerrequired
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/webhooks/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

webhook found

Bodyapplication/json
idinteger
company_idinteger
resourcestring
urlstring
activeboolean
auth_tokenstring or null
eventstring
http_methodstring
event_identifierstring
company_droplet_uuidstring or null
timeout_in_secondsinteger or null
Response
application/json
{
  "id": 0,
  "company_id": 0,
  "resource": "string",
  "url": "string",
  "active": true,
  "auth_token": "string",
  "event": "string",
  "http_method": "string",
  "event_identifier": "string",
  "company_droplet_uuid": "string",
  "timeout_in_seconds": 0
}

Update a webhook

Request

Path
idintegerrequired
Bodyapplication/json
webhookobject
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/webhooks/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "webhook": {
      "resource": "string",
      "url": "string",
      "active": true,
      "auth_token": "string",
      "event": "string",
      "http_method": "string"
    }
  }'

Responses

webhook updated

Delete a webhook

Request

Path
idintegerrequired
curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/webhooks/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

webhook deleted

Get webhook resource payload examples

Request

Path
resource_namestringrequired
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/webhooks/resources/{resource_name}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

resource payloads found

Bodyapplication/json
idinteger
Example: 123
namestring
Example: "cart_updated"
timestampstring(date-time)
Example: "2021-01-01T00:00:00Z"
identifierstring
Example: "commerce::cart-123"
payloadobject
Example: {"cart":{"id":123,"email":"jake@sully.com"},"resource":"cart","event":"updated","event_name":"cart_updated","company_id":1}
Response
application/json
{
  "id": 123,
  "name": "cart_updated",
  "timestamp": "2021-01-01T00:00:00Z",
  "identifier": "commerce::cart-123",
  "payload": {
    "cart": { … },
    "resource": "cart",
    "event": "updated",
    "event_name": "cart_updated",
    "company_id": 1
  }
}

returns a list of all droplet categories

Request

curl -i -X GET \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/droplet_categories \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

returns a list of droplet categories

Bodyapplication/json
droplet_categoriesArray of objects(DropletCategory)
metaobject
Response
application/json
{
  "droplet_categories": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}