Get notifications - Gable Docs

GET

notifications

Get notifications

curl --request GET \
  --url https://{hostname}.gable.ai/v0/notifications \
  --header 'X-API-KEY: <api-key>'

{
  "notifications": [
    {
      "id": "<string>",
      "changeLogEventId": "<string>",
      "actionId": "<string>",
      "actionDetails": {},
      "status": "PENDING",
      "createdAt": "2023-11-07T05:31:56Z",
      "retryCount": 1,
      "actionName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "userName": "<string>"
    }
  ]
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

limit

integer

The limit used for offset-based pagination

offset

integer

The offset used for offset-based pagination

orderBy

string

A field to order by

orderDir

string

Ordering direction ('asc' or 'desc')

Response

Successful operation

notifications

object[]

required

Show child attributes

notifications.id

string

required

The unique identifier of the created notification

notifications.changeLogEventId

string

required

The unique identifier of the change log event associated with the notification

notifications.actionId

string

required

The unique identifier of the action associated with the notification

notifications.actionDetails

object

required

Additional details about the action associated with the notification

notifications.status

enum<string>

required

The current status of the notification (e.g., "PENDING", "SENT", "FAILED")

Available options:

PENDING,

SENT,

FAILED

notifications.createdAt

string<date-time>

required

The timestamp when the notification was created

notifications.retryCount

integer

required

The number of times the notification has been retried

Required range: x >= 0

notifications.actionName

string

required

The name of the actions associated with the notification

notifications.updatedAt

string<date-time>

The timestamp when the notification was last updated

notifications.userName

string

The name of the user who created the action

Get notifications countGet notifications count

⌘I

Get notifications

curl --request GET \
  --url https://{hostname}.gable.ai/v0/notifications \
  --header 'X-API-KEY: <api-key>'

{
  "notifications": [
    {
      "id": "<string>",
      "changeLogEventId": "<string>",
      "actionId": "<string>",
      "actionDetails": {},
      "status": "PENDING",
      "createdAt": "2023-11-07T05:31:56Z",
      "retryCount": 1,
      "actionName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "userName": "<string>"
    }
  ]
}

Introduction

Gable

Authorizations

Query Parameters

Response