Loading ...

REST API: Send Custom Notification | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Users » REST API: Notifications » REST API: Send Custom Notification
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 31

REST API: Send Custom Notification

0 
 /5
0 (0votes)
Open API Guide
POST/api/notifications

Send a custom notification to specific people. ResponseData is true when the notification was sent. Any failure answers with a bare status code and an empty body.

This page documents POST /api/notifications, which notifies a list of user IDs. To notify everyone matching a persona, everyone holding a site role, or every member of a space, or to send the same message as an email, a wall post, a Slack message, or a Microsoft Teams message, use REST API: Add Custom Notification, which documents POST /api/notifications/custom.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.
Content-TypeYESapplication/jsonMust be set to application/json

Required Parameters

ParameterTypeRequiredLocationDescription
ToUserIDCSVStringYESBodyComma-separated list of user IDs of the people to whom you want to send the notification
ActionTextStringYESBodyNotification text that user is going to see
URLStringYESBodyURL that will open when the notification is clicked
IsCustomBooleanYESBodyMust be true. With false the endpoint expects an activity notification (EntityType, EntityID, and ActivityAction) instead and answers 400 without them.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/notifications

Request Body

{
  "IsCustom": true,
  "URL": "https://your-site.com/myaccount",
  "ActionText": "Hey guys, please take a look at the My Account page.",
  "ToUserIDCSV": "5,10,23,45,56,67,78"
}

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": true
}

Error Response

HTTP 500 with an empty body

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestThe body is missing, ActionText or URL is empty, or no recipient was given. The endpoint means to answer 400, but it builds that response inside a using block and disposes it before it is sent, so the caller gets a 500 with an empty body instead ("Cannot access a disposed object").Treat an empty 500 as a missing or invalid value: send ToUserIDCSV, ActionText, URL, and IsCustom true.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorA validation refusal reaching the caller as an empty 500, which is the same failure the 400 row describes. A genuine internal fault also answers this way, with an empty body in both cases.Check the body first, because an identical retry fails the same way: send ToUserIDCSV, ActionText, URL, and IsCustom true. Retry only once the body is known good.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages