API reference › Notifications › Module event trigger notifications

Get module event trigger notification by trigger name

GET /v1/settings/module-event-trigger-notifications/{trigger_name}

Scope
settings_notifications_preferences:read
Roles
admin, scheduler

Retrieves a specific trigger notification by its trigger name. Returns only the specific trigger data.

Parameters

Path parameters

NameTypeDescription
trigger_name requiredstring

Trigger name (e.g., assignment_created, shift_updated)

Example assignment_created.

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/{trigger_name}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Successful operation

Successful operation

JSON
{
  "success": true,
  "message": "Module event trigger notification retrieved successfully.",
  "data": {
    "triggerName": "Example name",
    "label": "Example label",
    "inApp": true,
    "email": true,
    "sms": true
  }
}
Response fields (8)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Module event trigger notification retrieved successfully..

dataobject
data.triggerNamestring

Example Example name.

data.labelstring

Example Example label.

data.inAppboolean

Example true.

data.emailboolean

Example true.

data.smsboolean

Example true.

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 .

404 Not found

Module event trigger notification not found

JSON
{
  "success": false,
  "message": "Module event trigger notification not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Module event trigger notification not found..

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.