Skip to main content

​
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"

​
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"

​
Common use cases

NeedModuleExample
In-app alert after payrollNotificationsPOST /api/v1/app/notifications
Store an uploaded fileFile ManagementPOST /api/v1/app/files
Payslip or invoice PDFDocumentsPOST /api/v1/app/documents/payslips
Long-running exportDocument JobsCreate 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.