Webhooks
/
Bulk delete webhooks

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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Admins

Operations

Agreements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Commerce Orders

Operations

Companies

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

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

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Labels

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Order Fulfillments

Operations

Orders

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Settings

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhooks

Operations

An array of webhooks

Request

Query
queryobject
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/webhooks?active=true&page=0&per_page=100&resource=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json
webhooksArray of objects(Webhook)required
webhooks[].​idintegerrequired
webhooks[].​company_idintegerrequired

The ID of the company that the resource belongs to

Example: 1
webhooks[].​droplet_installation_uuidstring or null

The UUID of the droplet installation if the webhook was created for a droplet

Example: "dri_1phkYdRcAWwms9iGwezxBbe1oDfvKiit3"
webhooks[].​urlstring\A(?x-mi: ([a-zA-Z][\-+.a-zA-Z\d]*): ...required

The URL the webhook events are sent to

Example: "https://example.com/webhook"
webhooks[].​activeboolean or null

Whether the webhook is currently active

Default true
Example: true
webhooks[].​resourcestringrequired

The resource that the webhook is for

Example: "droplet"
webhooks[].​eventstringrequired

The event that triggers the webhook

Example: "installed"
webhooks[].​event_identifierstring or null

The identifier for the event

Example: "droplet_installed"
webhooks[].​http_methodstringrequired

The HTTP method used to send the webhook event

Enum"post""put""get"
Example: "post"
webhooks[].​auth_tokenstring or null

The authentication token used verify webhook events

Example: "abc123"
webhooks[].​created_atstring(date-time)required

The date and time the webhook was created

Example: "2021-01-01T00:00:00Z"
webhooks[].​updated_atstring(date-time)required

The date and time the webhook was last updated

Example: "2021-01-01T00:00:00Z"
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
meta.​paginationobject
Response
application/json
{
  "webhooks": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z",
    "pagination": { … }
  }
}

Create a webhook

Request

Bodyapplication/json
webhookobjectrequired
webhook.​resourcestringrequired
webhook.​eventstringrequired
webhook.​urlstringrequired
webhook.​activeboolean
webhook.​auth_tokenstringnon-empty
webhook.​http_methodstringnon-empty
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/webhooks \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "webhook": {
      "resource": "string",
      "event": "string",
      "url": "string",
      "active": true,
      "auth_token": "string",
      "http_method": "string"
    }
  }'

Responses

success

Bodyapplication/json
webhookobject(Webhook)required
webhook.​idintegerrequired
webhook.​company_idintegerrequired

The ID of the company that the resource belongs to

Example: 1
webhook.​droplet_installation_uuidstring or null

The UUID of the droplet installation if the webhook was created for a droplet

Example: "dri_1phkYdRcAWwms9iGwezxBbe1oDfvKiit3"
webhook.​urlstring\A(?x-mi: ([a-zA-Z][\-+.a-zA-Z\d]*): ...required

The URL the webhook events are sent to

Example: "https://example.com/webhook"
webhook.​activeboolean or null

Whether the webhook is currently active

Default true
Example: true
webhook.​resourcestringrequired

The resource that the webhook is for

Example: "droplet"
webhook.​eventstringrequired

The event that triggers the webhook

Example: "installed"
webhook.​event_identifierstring or null

The identifier for the event

Example: "droplet_installed"
webhook.​http_methodstringrequired

The HTTP method used to send the webhook event

Enum"post""put""get"
Example: "post"
webhook.​auth_tokenstring or null

The authentication token used verify webhook events

Example: "abc123"
webhook.​created_atstring(date-time)required

The date and time the webhook was created

Example: "2021-01-01T00:00:00Z"
webhook.​updated_atstring(date-time)required

The date and time the webhook was last updated

Example: "2021-01-01T00:00:00Z"
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "webhook": {
    "id": 0,
    "company_id": 1,
    "droplet_installation_uuid": "dri_1phkYdRcAWwms9iGwezxBbe1oDfvKiit3",
    "url": "https://example.com/webhook",
    "active": true,
    "resource": "droplet",
    "event": "installed",
    "event_identifier": "droplet_installed",
    "http_method": "post",
    "auth_token": "abc123",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Show a webhook

Request

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

Responses

success

Bodyapplication/json
webhookobject(Webhook)required
webhook.​idintegerrequired
webhook.​company_idintegerrequired

The ID of the company that the resource belongs to

Example: 1
webhook.​droplet_installation_uuidstring or null

The UUID of the droplet installation if the webhook was created for a droplet

Example: "dri_1phkYdRcAWwms9iGwezxBbe1oDfvKiit3"
webhook.​urlstring\A(?x-mi: ([a-zA-Z][\-+.a-zA-Z\d]*): ...required

The URL the webhook events are sent to

Example: "https://example.com/webhook"
webhook.​activeboolean or null

Whether the webhook is currently active

Default true
Example: true
webhook.​resourcestringrequired

The resource that the webhook is for

Example: "droplet"
webhook.​eventstringrequired

The event that triggers the webhook

Example: "installed"
webhook.​event_identifierstring or null

The identifier for the event

Example: "droplet_installed"
webhook.​http_methodstringrequired

The HTTP method used to send the webhook event

Enum"post""put""get"
Example: "post"
webhook.​auth_tokenstring or null

The authentication token used verify webhook events

Example: "abc123"
webhook.​created_atstring(date-time)required

The date and time the webhook was created

Example: "2021-01-01T00:00:00Z"
webhook.​updated_atstring(date-time)required

The date and time the webhook was last updated

Example: "2021-01-01T00:00:00Z"
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "webhook": {
    "id": 0,
    "company_id": 1,
    "droplet_installation_uuid": "dri_1phkYdRcAWwms9iGwezxBbe1oDfvKiit3",
    "url": "https://example.com/webhook",
    "active": true,
    "resource": "droplet",
    "event": "installed",
    "event_identifier": "droplet_installed",
    "http_method": "post",
    "auth_token": "abc123",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update a webhook

Request

Path
idstringrequired
Bodyapplication/json
idstringrequired
webhookobjectrequired
webhook.​urlstringnon-empty
webhook.​activeboolean
webhook.​auth_tokenstringnon-empty
webhook.​http_methodstring
Enum"post""put""get"
curl -i -X PUT \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/webhooks/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "webhook": {
      "url": "string",
      "active": true,
      "auth_token": "string",
      "http_method": "post"
    }
  }'

Responses

success

Bodyapplication/json
webhookobject(Webhook)required
webhook.​idintegerrequired
webhook.​company_idintegerrequired

The ID of the company that the resource belongs to

Example: 1
webhook.​droplet_installation_uuidstring or null

The UUID of the droplet installation if the webhook was created for a droplet

Example: "dri_1phkYdRcAWwms9iGwezxBbe1oDfvKiit3"
webhook.​urlstring\A(?x-mi: ([a-zA-Z][\-+.a-zA-Z\d]*): ...required

The URL the webhook events are sent to

Example: "https://example.com/webhook"
webhook.​activeboolean or null

Whether the webhook is currently active

Default true
Example: true
webhook.​resourcestringrequired

The resource that the webhook is for

Example: "droplet"
webhook.​eventstringrequired

The event that triggers the webhook

Example: "installed"
webhook.​event_identifierstring or null

The identifier for the event

Example: "droplet_installed"
webhook.​http_methodstringrequired

The HTTP method used to send the webhook event

Enum"post""put""get"
Example: "post"
webhook.​auth_tokenstring or null

The authentication token used verify webhook events

Example: "abc123"
webhook.​created_atstring(date-time)required

The date and time the webhook was created

Example: "2021-01-01T00:00:00Z"
webhook.​updated_atstring(date-time)required

The date and time the webhook was last updated

Example: "2021-01-01T00:00:00Z"
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "webhook": {
    "id": 0,
    "company_id": 1,
    "droplet_installation_uuid": "dri_1phkYdRcAWwms9iGwezxBbe1oDfvKiit3",
    "url": "https://example.com/webhook",
    "active": true,
    "resource": "droplet",
    "event": "installed",
    "event_identifier": "droplet_installed",
    "http_method": "post",
    "auth_token": "abc123",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Delete a webhook

Request

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

Responses

success

Bodyapplication/json
webhookobject(Webhook)required
webhook.​idintegerrequired
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "webhook": {
    "id": 0
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Bulk delete webhooks

Request

Bodyapplication/json
webhook_idsArray of integersrequired
curl -i -X DELETE \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/webhooks/bulk_delete \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "webhook_ids": [
      0
    ]
  }'

Responses

success

Bodyapplication/json
webhooksobject(Webhook)required
webhooks.​webhook_idsArray of arraysrequired

The IDs of the webhooks that were deleted

Example: [5,19,42,87]
webhooks.​countintegerrequired

The number of webhooks that were deleted

Example: 4
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "webhooks": {
    "webhook_ids": [ … ],
    "count": 4
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}