v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Create Notification

Creates a notification in a workspace.

post/v1/notifications

Request body

senderIdstring required

ID of the entity sending the notification. This can be ID of client user, internal user, or a company.

recipientIdstring

Deprecated. Use recipientClientId, recipientCompanyId and recipientInternalUserId instead.

recipientClientIdstring

ID of the client receiving the notification. This required when sending a notification to a client.

recipientCompanyIdstring

ID of the company receiving the notification. This is required when sending a notification to a client that has more than one company.

recipientInternalUserIdstring

ID of the internal user receiving the notification. This is required when sending a notification to an internal user.

senderCompanyIdstring

The ID of the company associated with the sender of this notification. This is required when the sender is a client with more than one company.

Response

200

appIdstring

createdAtstring

eventstring

idstring

objectstring

recipientIdstring

recipientClientIdstring

recipientCompanyIdstring

recipientInternalUserIdstring

resourceIdstring

senderIdstring

senderTypestring

Example response

{
  "appId": "5b58089c-1e81-439c-b511-01e3e599c23d",
  "createdAt": "2024-02-22T18:17:01.577287641+05:30",
  "deliveryTargets": {
    "inProduct": {
      "title": "enquiry was done",
      "body": "details will be sent on mail",
      "ctaParams": {
        "foo": "bar"
      }
    },
    "email": {
      "subject": "New task",
      "header": "New task assigned",
      "body": "You have a new task to complete.",
      "title": "View Task",
      "ctaParams": {
        "foo": "bar"
      }
    }
  },
  "event": "customApp.action",
  "id": "bb9405f0-8644-4bb8-bbc8-84a1a05dcc01",
  "object": "notification",
  "recipientId": "5d686cec-6ef8-4394-a62c-0c2fde950669",
  "recipientClientId": "5d686cec-6ef8-4394-a62c-0c2fde950669",
  "recipientCompanyId": "5d686cec-6ef8-4394-a62c-0c2fde950669",
  "recipientInternalUserId": "5d686cec-6ef8-4394-a62c-0c2fde950669",
  "resourceId": "3a5981d8-6619-4dc6-b9b9-a791d275bd5c",
  "senderId": "33da2a16-f525-4d4b-99c8-a273f6260f43",
  "senderType": "client"
}