Utils quickstart

Fluide Utils handles cross-cutting tasks your integration may need alongside HR, Payroll, Pay, or Books: notifications, file storage, and document generation.

Prerequisites

Developer credentials and access token — Authorization.

1. Verify connectivity

curl -X GET "$FLUIDE_BASE_URL/api/v1/app" \
  -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \
  -H "X-Fluide-Api-Key: $FLUIDE_API_KEY" \
  -H "X-Fluide-Client-Id: fluide-developer"

const res = await fetch(`${baseUrl}/api/v1/app`, {
  headers: {
    Authorization: `Bearer ${accessToken}`,
    'X-Fluide-Api-Key': process.env.FLUIDE_API_KEY!,
    'X-Fluide-Client-Id': 'fluide-developer',
  },
});

if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);

2. List notifications

curl -X GET "$FLUIDE_BASE_URL/api/v1/app/notifications" \
  -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \
  -H "X-Fluide-Api-Key: $FLUIDE_API_KEY" \
  -H "X-Fluide-Client-Id: fluide-developer"

const res = await fetch(`${baseUrl}/api/v1/app/notifications`, {
  headers: {
    Authorization: `Bearer ${accessToken}`,
    'X-Fluide-Api-Key': process.env.FLUIDE_API_KEY!,
    'X-Fluide-Client-Id': 'fluide-developer',
  },
});

if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);

Common use cases

Need	Module	Example
In-app alert after payroll	Notifications	`POST /api/v1/app/notifications`
Store an uploaded file	File Management	`POST /api/v1/app/files`
Payslip or invoice PDF	Documents	`POST /api/v1/app/documents/payslips`
Long-running export	Document Jobs	Create job, poll status

See Utils modules and Utils API reference for request shapes and response fields.

Utils overview

When to call Utils from other products.

Utils API reference

Browse and try Utils endpoints.

Utils overview Utils modules

​Utils quickstart

​Prerequisites

​1. Verify connectivity

​2. List notifications

​Common use cases