Skip to main content
POST
/
api
/
notifications
/
subscriptions
Create webhook subscription
curl --request POST \
  --url https://api.walletsuite.io/api/notifications/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "address": "<string>",
  "eventKinds": [],
  "webhookUrl": "<string>"
}
'
{
  "ok": true,
  "code": "<string>",
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "chain": "<string>",
    "address": "<string>",
    "eventKinds": [
      "<string>"
    ],
    "webhookUrl": "<string>",
    "status": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "failureCount": 123,
    "lastSuccessAt": "2023-11-07T05:31:56Z",
    "pausedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

API key provided by WalletSuite team

Body

application/json
​
chain
enum<string>
required

Chain to watch.

Available options:
ethereum,
tron
​
address
string
required

Address to watch for incoming transfers.

Maximum string length: 128
​
eventKinds
enum<string>[]
required

Asset-scope filters: which incoming transfer kinds to deliver.

Maximum array length: 8
Available options:
INCOMING_NATIVE,
INCOMING_FUNGIBLE
​
webhookUrl
string
required

HTTPS endpoint (port 443, publicly resolvable) that receives deliveries.

Maximum string length: 2048

Response

Accepted - registration in progress

​
ok
boolean
​
code
string
​
message
string
​
data
object