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); a droplet token needs the scope
that guards the resource (403 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.dundermifflin.com/fluid/orders",
"active": true,
"http_method": "post",
"auth_token": "k7Jf2Qm9RtV8xZ1aB4cD6eG0hL3nP5s",
"points_format": "whole"
}
}
'
{
"webhook": {
"id": 48213,
"company_id": 1405,
"droplet_installation_uuid": null,
"url": "https://hooks.dundermifflin.com/fluid/orders",
"active": true,
"resource": "order",
"event": "created",
"event_identifier": "order_created",
"http_method": "post",
"auth_token": "k7Jf2Qm9RtV8xZ1aB4cD6eG0hL3nP5s",
"created_at": "2026-09-14T15:22:08.412Z",
"updated_at": "2026-09-14T15:22:08.412Z"
},
"meta": {
"request_id": "8f3c2b71-5d4e-4a9b-b6f0-1e7a9c3d2f58",
"timestamp": "2026-09-30T14:05:12Z"
}
}{
"message": "<string>"
}{
"message": "<string>",
"error": "<string>"
}{
"error_message": "<string>",
"errors": "<string>",
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}⌘I
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.dundermifflin.com/fluid/orders",
"active": true,
"http_method": "post",
"auth_token": "k7Jf2Qm9RtV8xZ1aB4cD6eG0hL3nP5s",
"points_format": "whole"
}
}
'
{
"webhook": {
"id": 48213,
"company_id": 1405,
"droplet_installation_uuid": null,
"url": "https://hooks.dundermifflin.com/fluid/orders",
"active": true,
"resource": "order",
"event": "created",
"event_identifier": "order_created",
"http_method": "post",
"auth_token": "k7Jf2Qm9RtV8xZ1aB4cD6eG0hL3nP5s",
"created_at": "2026-09-14T15:22:08.412Z",
"updated_at": "2026-09-14T15:22:08.412Z"
},
"meta": {
"request_id": "8f3c2b71-5d4e-4a9b-b6f0-1e7a9c3d2f58",
"timestamp": "2026-09-30T14:05:12Z"
}
}{
"message": "<string>"
}{
"message": "<string>",
"error": "<string>"
}{
"error_message": "<string>",
"errors": "<string>",
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}