Get Notification History

curl --request GET \
  --url https://alerts-api.dial.to/v2/history \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Dialect-Client-Key: <x-dialect-client-key>'

{
  "alerts": [
    {
      "id": "<string>",
      "timestamp": "2024-02-20T15:30:00.000Z",
      "title": "<string>",
      "body": "<string>",
      "image": "https://www.dialect.to/favicon.ico",
      "actions": [
        {
          "type": "<string>",
          "label": "<string>",
          "url": "<string>",
          "context": {
            "type": "<string>",
            "apiUrl": "<string>",
            "action": "<string>"
          }
        }
      ],
      "topic": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Product Announcements",
        "slug": "product-announcements"
      },
      "app": {
        "id": "255d6163-7e25-43e9-a188-c2f8d0980a4a",
        "name": "Dialect",
        "icon": "https://dialect-file-storage.s3.us-west-2.amazonaws.com/avatars/dialect-logo.png"
      },
      "data": {
        "type": "transaction",
        "transactionId": "123",
        "amount": "100"
      }
    }
  ],
  "summary": {
    "unreadCount": 5,
    "lastRead": {
      "timestamp": "2024-02-20T15:30:00.000Z"
    }
  },
  "limit": 10,
  "cursor": "<string>"
}

GET

history

curl --request GET \
  --url https://alerts-api.dial.to/v2/history \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Dialect-Client-Key: <x-dialect-client-key>'

{
  "alerts": [
    {
      "id": "<string>",
      "timestamp": "2024-02-20T15:30:00.000Z",
      "title": "<string>",
      "body": "<string>",
      "image": "https://www.dialect.to/favicon.ico",
      "actions": [
        {
          "type": "<string>",
          "label": "<string>",
          "url": "<string>",
          "context": {
            "type": "<string>",
            "apiUrl": "<string>",
            "action": "<string>"
          }
        }
      ],
      "topic": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Product Announcements",
        "slug": "product-announcements"
      },
      "app": {
        "id": "255d6163-7e25-43e9-a188-c2f8d0980a4a",
        "name": "Dialect",
        "icon": "https://dialect-file-storage.s3.us-west-2.amazonaws.com/avatars/dialect-logo.png"
      },
      "data": {
        "type": "transaction",
        "transactionId": "123",
        "amount": "100"
      }
    }
  ],
  "summary": {
    "unreadCount": 5,
    "lastRead": {
      "timestamp": "2024-02-20T15:30:00.000Z"
    }
  },
  "limit": 10,
  "cursor": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer token authentication for subscriber calls

Headers

X-Dialect-Client-Key

string

required

Client Key used to uniquely identify the client

Example:

"dk_gyh2eqzfkc4mhp5eiahnndkz"

Query Parameters

appId

string<uuid>

Application ID

Example:

"255d6163-7e25-43e9-a188-c2f8d0980a4a"

limit

number

default:10

Pagination limit

Required range: 1 <= x <= 20

Example:

10

cursor

string

Pagination cursor

Response

Notification history retrieved with detailed alert data

alerts

object[]

required

Show child attributes

alerts.id

string

required

Id uniquely identifying alerts

alerts.timestamp

string

required

ISO Timestamp

Example:

"2024-02-20T15:30:00.000Z"

alerts.title

string

required

Required string length: 1 - 100

alerts.body

string

required

Required string length: 1 - 500

alerts.image

string<uri>

Image URL

Example:

"https://www.dialect.to/favicon.ico"

alerts.actions

object[]

Show child attributes

alerts.actions.type

string

required

Allowed value: "link"

alerts.actions.label

string

required

Required string length: 1 - 50

alerts.actions.url

string<uri>

required

Minimum string length: 1

alerts.actions.context

object

Show child attributes

alerts.actions.context.type

string

required

Allowed value: "position"

alerts.actions.context.apiUrl

string<uri>

required

alerts.actions.context.action

string

Minimum string length: 1

alerts.topic

object

Show child attributes

alerts.topic.id

string<uuid>

required

Topic ID

Minimum string length: 1

Example:

"123e4567-e89b-12d3-a456-426614174000"

alerts.topic.name

string

required

Topic name

Minimum string length: 1

Example:

"Product Announcements"

alerts.topic.slug

string

required

Topic slug

Minimum string length: 1

Example:

"product-announcements"

alerts.app

object

Show child attributes

alerts.app.id

string<uuid>

required

Application ID

Example:

"255d6163-7e25-43e9-a188-c2f8d0980a4a"

alerts.app.name

string

required

Application name

Minimum string length: 1

Example:

"Dialect"

alerts.app.icon

string<uri>

Icon URL

Example:

"https://dialect-file-storage.s3.us-west-2.amazonaws.com/avatars/dialect-logo.png"

alerts.data

object

Additional data to be sent with the alert. For push notifications, this data will be available in the notification payload and can be used by the app to handle the notification. Common use cases include deep linking, custom actions, or passing context to the app.

Show child attributes

alerts.data.{key}

string

Required string length: 1 - 500

Example:

{
  "type": "transaction",
  "transactionId": "123",
  "amount": "100"
}

summary

object

required

Show child attributes

summary.unreadCount

number

required

Total number of unread alerts

Example:

5

summary.lastRead

object

Show child attributes

summary.lastRead.timestamp

string<date-time>

required

ISO Timestamp

Example:

"2024-02-20T15:30:00.000Z"

limit

number

default:10

required

Pagination limit

Required range: 1 <= x <= 20

Example:

10

cursor

string

Pagination cursor

Verify Solana Transaction Authentication Get Notification Summary

⌘I

GETTING STARTED

SETUP

INTEGRATE AN INBOX

SEND ALERTS

MOBILE ALERTS STACK

EVENTS (Beta)

MONITORING

API REFERENCE

Get Notification History

Authorizations

Headers

Query Parameters

Response