Sign in

v1

latestOpenAPI 3.1.02026-07-243035381.4 MB
Notifications

List all executed webhooks

This endpoint is compatible with our deprecated v3 Notifications product. To use it with v3, simply replace 'v4' with 'v3' in the request URL.

<p style="display: none">/v4/subscription/webhook</p> <p>List all webhooks.</p>
get/v4/subscription/webhook

Query parameters

pageSizenumber required
Example:10

Max number of items per page is 50.

offsetnumber

Offset to obtain the next page of data.

direction'asc' | 'desc'
Example:asc

Direction of sorting

failedboolean

Flag indicating whether the webhook was successful or not

subscriptionIdstring
Example:507f1f77bcf86cd799439011

Filter by alert ID.

fromnumber
Example:1700000000

Return webhooks created at or after this Unix timestamp in seconds.

tonumber
Example:1700001000

Return webhooks created at or before this Unix timestamp in seconds.

Response

OK

type'ADDRESS_EVENT' | 'CONTRACT_ADDRESS_LOG_EVENT' | 'INCOMING_NATIVE_TX' | 'OUTGOING_NATIVE_TX' | 'OUTGOING_FAILED_TX' | 'PAID_FEE' | 'INCOMING_INTERNAL_TX' | 'OUTGOING_INTERNAL_TX' | 'INCOMING_FUNGIBLE_TX' | 'OUTGOING_FUNGIBLE_TX' | 'INCOMING_NFT_TX' | 'OUTGOING_NFT_TX' | 'INCOMING_MULTITOKEN_TX' | 'OUTGOING_MULTITOKEN_TX' | 'FAILED_TXS_PER_BLOCK' | 'PRICE_CHANGE' required

Type of the alert.

idstring required

ID of the WebHook

subscriptionIdstring required

ID of the alert

urlstring required

URL of the endpoint, where HTTP POST request will be sent.

dataobject required

Data of webhook

nextTimenumber

Next webhook execution try time

timestampnumber

Webhook execution time

retryCountnumber

Number

failedboolean required

Flag indicating whether this webhook was successful or not

notestring

Any other relevant information such as important updates

Example response

[
  {
    "type": "ADDRESS_EVENT",
    "id": "7c21ed165e294db78b95f0f1",
    "subscriptionId": "7c21ed165e294db78b95f0f1",
    "url": "https://dashboard.tatum.io/webhook-handler",
    "nextTime": 1653320900353,
    "timestamp": 1653320900353,
    "retryCount": 3,
    "response": {
      "code": 500,
      "data": "Internal server error"
    }
  }
]