notifications

Retrieve a specific notification by id

Changed on
get/notifications/{id}/

Request

  • The document declares no server URL.
  • Auth: API key in header Authorization

Path parameters

idstring uuid required

A UUID string identifying this notification.

Response

idstring uuid required
resource_controllerstring required
resource_actionstring required
resource_uuidstring uuid nullable
status'nothing_happened' | 'got_notification' | 'viewed_notification' | 'opened_notification'
  • nothing_happened - Nothing Happened
  • got_notification - User Got Notification
  • viewed_notification - User Viewed Notification
  • opened_notification - User Opened Notification
descriptionstring nullable
messagestring nullable
message_type'success' | 'failed' | 'warning' | 'pending'
  • success - Success
  • failed - Failed
  • warning - Warning
  • pending - Pending
created_atstring date-time required

Changes

  • edd2c4f2de3bRevision changes
    • breaking

      removed the required property from the response with the status

    • info

      for the path request parameter id, the type was generalized from integer to string, and format from no format to uuid

    • info

      added the required property to the response with the status