{
  "subscriptionId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
  "notificationId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
  "notificationType": "transactions.outbound",
  "notification": {
    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "blockchain": "MATIC-AMOY",
    "createDate": "2023-01-01T12:04:05Z",
    "updateDate": "2023-01-01T12:04:05Z",
    "abiFunctionSignature": "burn(uint256)",
    "abiParameters": [
      "100",
      "1"
    ],
    "amounts": [
      "6.62607015"
    ],
    "amountInUSD": "<string>",
    "blockHash": "<string>",
    "blockHeight": 123,
    "contractAddress": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
    "destinationAddress": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
    "errorReason": "<string>",
    "errorDetails": "<string>",
    "estimatedFee": {
      "gasLimit": "21000",
      "gasPrice": "<string>",
      "maxFee": "5.935224468",
      "priorityFee": "1.022783914",
      "baseFee": "1.022783914",
      "networkFee": "0.0001246397138",
      "networkFeeRaw": "0.0001246397138",
      "l1Fee": "0.000000000000140021"
    },
    "feeLevel": "MEDIUM",
    "firstConfirmDate": "2021-05-18T00:00:00Z",
    "networkFee": "<string>",
    "networkFeeInUSD": "<string>",
    "nfts": [
      "[{\"ntfTokenId\":\"12321\"",
      "\"metadata\":\"ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/1\"}",
      "{\"ntfTokenId\":\"12322\"",
      "\"metadata\":\"ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/2\"}]"
    ],
    "refId": "grouptransaction123",
    "sourceAddress": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
    "tokenId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
    "userId": "ext_user_id_1",
    "walletId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5"
  },
  "timestamp": "2023-11-07T05:31:56Z",
  "version": 123
}

Outbound transaction notification

Sent when an outbound transaction changes state. The lifecycle state of the transaction is conveyed by the state field on the notification object.

States covered by this notification type:

QUEUED: the transaction has been initiated but has not yet been processed.
SENT: the transaction has been processed and sent to a blockchain node but has not yet been broadcast onchain.
CONFIRMED: the transaction has been broadcast onchain and is awaiting the required number of confirmations.
COMPLETE: the transaction has reached the required confirmations and the funds are available in the destination account.
CANCELED: a cancel request for the transaction has been confirmed.
FAILED: the transaction failed (for example, due to insufficient balance or a failed challenge).

WEBHOOK

transactionsOutbound

{
  "subscriptionId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
  "notificationId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
  "notificationType": "transactions.outbound",
  "notification": {
    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "blockchain": "MATIC-AMOY",
    "createDate": "2023-01-01T12:04:05Z",
    "updateDate": "2023-01-01T12:04:05Z",
    "abiFunctionSignature": "burn(uint256)",
    "abiParameters": [
      "100",
      "1"
    ],
    "amounts": [
      "6.62607015"
    ],
    "amountInUSD": "<string>",
    "blockHash": "<string>",
    "blockHeight": 123,
    "contractAddress": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
    "destinationAddress": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
    "errorReason": "<string>",
    "errorDetails": "<string>",
    "estimatedFee": {
      "gasLimit": "21000",
      "gasPrice": "<string>",
      "maxFee": "5.935224468",
      "priorityFee": "1.022783914",
      "baseFee": "1.022783914",
      "networkFee": "0.0001246397138",
      "networkFeeRaw": "0.0001246397138",
      "l1Fee": "0.000000000000140021"
    },
    "feeLevel": "MEDIUM",
    "firstConfirmDate": "2021-05-18T00:00:00Z",
    "networkFee": "<string>",
    "networkFeeInUSD": "<string>",
    "nfts": [
      "[{\"ntfTokenId\":\"12321\"",
      "\"metadata\":\"ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/1\"}",
      "{\"ntfTokenId\":\"12322\"",
      "\"metadata\":\"ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/2\"}]"
    ],
    "refId": "grouptransaction123",
    "sourceAddress": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
    "tokenId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
    "userId": "ext_user_id_1",
    "walletId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5"
  },
  "timestamp": "2023-11-07T05:31:56Z",
  "version": 123
}

Body

application/json

Envelope sent to your endpoint for every webhook notification. The shape of the notification field depends on notificationType.

subscriptionId

string<uuid>

required

ID of the webhook subscription that produced this notification.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

notificationId

string<uuid>

required

Unique ID for this event notification. Stable across retries of the same event.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

notificationType

enum<string>

required

The type of notification.

Available options:

transactions.outbound

notification

Transaction · object

required

The event payload. The schema of this object depends on notificationType.

Show child attributes

timestamp

string<date-time>

required

When the notification was produced.

version

integer

required

The version of the notification schema.

Response

200

Webhook received successfully.

Inbound transaction notification

Challenge notification

⌘I