webhooks

Create a webhook

Creates a webhook subscription: Fluid delivers a JSON payload to url each time the chosen event fires on the chosen resource. resource, event, and url are required; active, http_method, and auth_token (the shared secret Fluid signs deliveries with) are optional. Returns 201 with the subscription under a webhook key — including its integer id and the event_identifier for the event’s payload schema — and 422 when the body fails validation. Requires a company Bearer token (401 otherwise). In production url must be a publicly reachable HTTPS endpoint.

POST

api

company

webhooks

curl --request POST \
  --url https://api.fluid.app/api/company/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhook": {
    "resource": "order",
    "event": "created",
    "url": "https://hooks.acme-wellness.com/fluid/orders",
    "active": true,
    "http_method": "post",
    "auth_token": "k7Jf2Qm9RtV8xZ1aB4cD6eG0hL3nP5s"
  }
}
'

{
  "webhook": {
    "id": 123,
    "company_id": 123,
    "droplet_installation_uuid": "<string>",
    "url": "<string>",
    "active": true,
    "resource": "<string>",
    "event": "<string>",
    "event_identifier": "<string>",
    "auth_token": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>"
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication

Body

application/json

webhook

object

required

Show child attributes

Response

Webhook created

webhook

object

required

Webhook subscription

Show child attributes

meta

object

Show child attributes

List webhooks

Bulk delete webhooks

curl --request POST \
  --url https://api.fluid.app/api/company/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhook": {
    "resource": "order",
    "event": "created",
    "url": "https://hooks.acme-wellness.com/fluid/orders",
    "active": true,
    "http_method": "post",
    "auth_token": "k7Jf2Qm9RtV8xZ1aB4cD6eG0hL3nP5s"
  }
}
'

{
  "webhook": {
    "id": 123,
    "company_id": 123,
    "droplet_installation_uuid": "<string>",
    "url": "<string>",
    "active": true,
    "resource": "<string>",
    "event": "<string>",
    "event_identifier": "<string>",
    "auth_token": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>"
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Overview

Task guides

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Create a webhook

Authorizations

Body

Response