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
| Name | Type | Description |
|---|---|---|
trigger_name required | string | Trigger name (e.g., assignment_created, shift_updated) Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
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
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.triggerName | string | Example |
data.label | string | Example |
data.inApp | boolean | Example |
data.email | boolean | Example |
data.sms | boolean | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
404 Not found
Module event trigger notification not found
{
"success": false,
"message": "Module event trigger notification not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |