API reference › Notifications › Module event trigger notifications

Get all module event trigger notifications

GET /v1/settings/module-event-trigger-notifications

Scope
settings_notifications_preferences:read
Roles
admin, scheduler

Retrieves a paginated list of module event trigger notifications with search and filtering. Supports fuzzy search on trigger names.

Parameters

Query parameters

NameTypeDescription
moduleNamestring

Filter by specific module name (e.g., assignments, shifts, requests)

Example shifts.

searchstring

Search query to filter module event trigger notifications by trigger name (supports fuzzy search with spaces and partial matches)

Example shift created.

sort_bystring

Sort field

Example module_name.

sort_orderstring

Sort order (asc or desc)

Example asc.

per_pageinteger

Number of items per page

Example 10.

pageinteger

Current page number

Example 1.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
curl "https://api.fetchfido.ai/v1/settings/module-event-trigger-notifications" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Successful operation

Successful operation

JSON
{
  "success": true,
  "data": [
    {
      "triggerName": "shift_created",
      "label": "Shift Created",
      "moduleName": "shifts",
      "inApp": true,
      "email": false,
      "sms": true
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "perPage": 10,
    "total": 3
  }
}
Response fields (13)
FieldTypeDescription
successboolean

Example true.

dataarray of object
data[].triggerNamestring

Example shift_created.

data[].labelstring

Example Shift Created.

data[].moduleNamestring

Example shifts.

data[].inAppboolean

Example true.

data[].emailboolean

Example false.

data[].smsboolean

Example true.

metaobject
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 1.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 3.

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'settings_notifications_preferences:read' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'settings_notifications_preferences:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred — please try again."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..