POST
/
v2
/
{appId}
/
send
Send Alert
curl --request POST \
  --url https://alerts-api.dial.to/v2/{appId}/send \
  --header 'Content-Type: application/json' \
  --header 'x-dialect-api-key: <api-key>' \
  --data '{
  "channels": [
    "PUSH"
  ],
  "message": {
    "title": "Alert Title",
    "body": "Alert body",
    "image": "https://dialect-file-storage.s3.us-west-2.amazonaws.com/avatars/dialect-logo.png",
    "actions": [
      {
        "type": "link",
        "label": "Open Link",
        "url": "https://dialect.to"
      }
    ]
  },
  "topicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "type": "transaction",
    "transactionId": "123",
    "amount": "100"
  },
  "push": {},
  "recipient": {
    "type": "subscriber",
    "walletAddress": "6CxnSjtasq5Tzwb4b93AhLofXtiDvMpQ2vTkWdSZqTH7"
  }
}'
{}

Authorizations

​
x-dialect-api-key
string
header
required

API key to authorize app-level requests

Path Parameters

​
appId
string<uuid>
required

Application ID

Example:

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

Body

application/json
​
channels
enum<string>[]
required
Minimum length: 1
​
message
object
required
​
recipient
object
required
Example:
{
  "type": "subscriber",
  "walletAddress": "6CxnSjtasq5Tzwb4b93AhLofXtiDvMpQ2vTkWdSZqTH7"
}
​
topicId
string<uuid> | null

Optional topic ID to categorize the alert. Must be created in advance and belong to the authenticated app. If absent, the alert is uncategorized. If invalid or unauthorized, the request will fail.

​
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.

Example:
{
  "type": "transaction",
  "transactionId": "123",
  "amount": "100"
}
​
push
object

Push notification specific configuration.

Response

Message sent successfully

The response is of type object.