Skip to main content
POST
/
api
/
spaces
/
coworkernotifications
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A CoworkerNotification represents a push notification sent to a customer (coworker). Notifications are generated by the system in response to various events such as new blog posts, community messages, invoices, identity checks, and more. Notifications are read-only — they can be listed and retrieved but not created or modified via the API. The NotificationType field indicates the source event. Common values include:
NotificationTypeMeaning
blogNew blog post published
community-eventCommunity event update
community-messageNew community message
community-threadNew community thread
courseCourse update
coworkerinvoiceNew invoice generated
identitycheck-failIdentity check failed
identity-check-failedIdentity check failed (alternate)
identity-check-successIdentity check succeeded
identitycheck-successIdentity check succeeded (alternate)
push-notificationGeneric push notification
reply-likeSomeone liked a reply
salto-lockerSalto locker event
surveySurvey notification
thread-likeSomeone liked a thread

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CoworkerNotification-Create role.

​
Request Body

​
Required Fields

​
CoworkerId
integer
required
Coworker Id.
​
Message
string
required
The notification message body displayed to the coworker.
​
NotificationType
string
required
The type of event that triggered this notification (e.g. blog, community-event, coworkerinvoice, push-notification).
​
EntityId
integer
required
The ID of the entity related to this notification (e.g. the blog post, invoice, or thread that triggered it).

​
Optional Fields

​
IsDismissed
boolean
Whether the coworker has dismissed this notification.

​
Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/coworkernotifications" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "Message": "",
    "NotificationType": "",
    "EntityId": 0
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the creation.
​
Value
object
Contains the Id of the newly created record.
​
WasSuccessful
boolean
true if the coworkernotification was created successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "CoworkerNotification was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

​
400

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Message: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Message"
    }
  ],
  "WasSuccessful": false
}