Skip to main content
POST
/
api
/
v1
/
app
/
notifications
/
engagement-template
cURL
curl -sS -X POST "$FLUIDE_BASE_URL/api/v1/app/notifications/engagement-template" \
  -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \
  -H "X-Fluide-Api-Key: $FLUIDE_API_KEY" \
  -H "X-Fluide-Client-Id: fluide-developer" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {}
}

Authorizations

​
Authorization
string
header
required

Access token JWT. Use as Authorization: Bearer . In the API playground, paste the JWT only.

​
X-Fluide-Api-Key
string
header
default:fl_dev_your_key
required

Developer API key (fl_dev_...). Required on every API call with a machine access token.

​
X-Fluide-Client-Id
string
header
default:fluide-developer
required

First-party client audience. Must match the fluide_client_id claim on the JWT. Use fluide-developer for Connect.

Body

application/json
​
recipientId
string<uuid>
required

Recipient user ID

​
event
enum<string>
required
Available options:
ENGAGEMENT_INVITED,
ENGAGEMENT_ACCEPTED,
ENGAGEMENT_TERMINATED,
ALL_MODULES_OUTSOURCED
​
engagementId
string
required

Engagement id

​
businessOrgName
string

Business organization name

​
vmOrgName
string

Virtual manager organization name

​
companyName
string

Target company name

​
engagementType
string

Engagement module type (HR | PAYROLL | BOOKS | PAY)

​
reason
string

Reason/comment (terminate/cancel)

Response

Create engagement lifecycle notification from template — created

​
success
boolean
required

Whether the request succeeded

Example:

true

​
message
string
required

Human-readable outcome message (localized when i18n is configured)

Example:

"Operation completed successfully"

​
data
object

Endpoint-specific payload