NInixopus
Notifications

Send notification

Changed on

Send notification.

Auth: Required (bearer token). Scope: Organization-scoped in authenticated context. Side effects: May mutate server state.

post/api/v1/notification/send

Request

  • Base URL
    http://:8080
  • URL
    http://:8080/api/v1/notification/send
  • Auth
    none declared

Headers

Acceptstring

Request body */*

channelstring required

Notification delivery channel

messagestring required

Notification message body

metadataobject nullable

Additional key-value metadata for the notification

subjectstring nullable

Email subject line (only for email channel)

tostring nullable

Recipient email address (only for email channel)

Example request

{
  "channel": "email",
  "message": "Deployment completed successfully",
  "subject": "Deployment Update",
  "to": "user@example.com"
}

Response

OK

messagestring
statusstring

Changes

  • 09f18af670c4Revision changes
    • info

      api tag Notifications added

    • info

      api tag api/v1/notification removed

    • info

      api tag send removed

  • 2beb810c5221Revision changes
    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • info

      api operation id createSend removed and replaced with sendNotification

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/xml)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)