Skip to main content

Webhook

Webhook concept​

Octet provides webhooks so that you can track events within Octet, such as deposits and withdrawals, in real time. If you register a URL to receive the data for a specific event, Octet sends the data to that URL when the event occurs.

  • Protocol: HTTP/1.1 POST
  • Request body: JSON Array
  • Allowed ports: 443 (https), 80 (http)

Supported webhook events​

Webhooks are sent when a transaction is completed. Webhooks are also sent when a transaction fails.

EventWhen it is sent
Deposit in progress (UNFINALIZED_DEPOSIT)When the deposit transaction is in progress (UNFINALIZED)
Deposit completed (DEPOSIT)When the deposit transaction is completed (FINALIZED)
Gathering completed (GATHERING)When the gathering transaction is completed (FINALIZED)
Withdrawal request succeeded (SENT_WITHDRAWAL)When the withdrawal request succeeds (SENT)
Withdrawal request failed (FAILED_WITHDRAWAL)When the withdrawal request fails (FAILED)
Withdrawal awaiting signing (AWAITING_SIGNING_WITHDRAWAL)When the withdrawal request build succeeds (AWAITING_SIGNING)
Withdrawal completed (WITHDRAWAL)When the withdrawal transaction is completed (FINALIZED) or fails (FAILED)
NFT contract deployment completed (NFT_DEPLOYMENT)When the NFT contract deployment transaction is completed (FINALIZED) or fails (FAILED)
NFT item minting completed (NFT_ITEM_CREATION)When the NFT item minting transaction is completed (FINALIZED) or fails (FAILED)
NFT deposit in progress (UNFINALIZED_NFT_DEPOSIT)When the NFT deposit transaction is in progress (UNFINALIZED)
NFT deposit completed (NFT_DEPOSIT)When the NFT deposit transaction is completed (FINALIZED)
NFT withdrawal completed (NFT_WITHDRAWAL)When the NFT withdrawal transaction is completed (FINALIZED) or fails (FAILED)
NFT burn completed (NFT_BURN)When the NFT burn transaction is completed (FINALIZED) or fails (FAILED)
NFT contract method execution completed (NFT_CONTRACT_METHOD_EXECUTION)When the NFT contract method execution transaction is completed (FINALIZED) or fails (FAILED)
Transaction signing completed (SIGNING_TRANSACTION)When transaction signing succeeds (SUCCESS) or fails (FAILED)
Data signing completed (SIGNING_DATA)When data signing succeeds (SUCCESS) or fails (FAILED)
Contract execution completed (CONTRACT_EXECUTION)When the contract execution transaction is completed (FINALIZED) or fails (FAILED)

Data format​

For transmission efficiency, the body of the HTTP request takes the form of an array. When a large number of deposits occur within a short time, multiple deposits are included in the array and sent together.

👀

If different webhooks are registered to the same URL, the contents of multiple webhooks are included in a single payload and sent together.


Data examples​

1. Deposit, withdrawal, gathering​

[
{
"webhookIdx": 75,
"webhookTargetIdx": 214224,
"webhookTargetDataScheme": "TRANSACTION_1",
"data": {
"memo": null,
"txid": "0x670d0c04ec2c11d6bc5800197e028b9196d256e132fcaee5b54fe20c55fa1c34",
"type": "DEPOSIT",
"uuid": "8d62e40a-6315-410b-a42e-a6b3061c661b",
"nonce": 53198,
"amount": "0.25000000000000000000",
"status": "FINALIZED",
"symbol": "ETH",
"usedFee": "0.00000424649261400000",
"toAddress": "0x71b5De2970A32eEf6362AE7Bc3B73103b4392bB0",
"failedDate": null,
"blockHeight": "7496435",
"createdDate": "2022-08-30T16:21:10",
"fromAddress": "0x2031832e54a2200bF678286f560F49A950DB2Ad5",
"outputIndex": 0,
"toAddresses": [
"0x71b5De2970A32eEf6362AE7Bc3B73103b4392bB0"
],
"modifiedDate": "2022-08-30T16:24:01",
"finalizedDate": "2022-08-30T16:24:02",
"fromAddresses": [
"0x2031832e54a2200bF678286f560F49A950DB2Ad5"
],
"contractAddress": null,
"feePayerAddress": null,
"unfinalizedDate": "2022-08-30T16:21:11",
"useFeeDelegation": false,
"transactionCurrency": {
"krw": null,
"usd": null
}
}
},
{
"webhookIdx": 77,
"webhookTargetIdx": 214743,
"webhookTargetDataScheme": "TRANSACTION_1",
"data": {
"memo": null,
"txid": "0xa582377ad2bf7ab8dd87d42ca71fe9632398c47fad967ee360c9c599147c0612",
"type": "WITHDRAWAL",
"uuid": "ce777d55-feb8-4f51-a092-278d67dea0fa",
"nonce": 113,
"amount": "0.00010000000000000000",
"status": "FINALIZED",
"symbol": "ETH",
"usedFee": "0.000021000133917",
"toAddress": "0x1D31aB94201b3a25557fdC6dc2E4c860199E32Da",
"failedDate": null,
"blockHeight": "8034466",
"createdDate": "2022-11-28T15:42:50",
"fromAddress": "0x71b5De2970A32eEf6362AE7Bc3B73103b4392bB0",
"outputIndex": 0,
"toAddresses": [
"0x1D31aB94201b3a25557fdC6dc2E4c860199E32Da"
],
"modifiedDate": "2022-11-28T15:42:50",
"finalizedDate": "2022-11-28T15:43:20",
"fromAddresses": [
"0x71b5De2970A32eEf6362AE7Bc3B73103b4392bB0"
],
"contractAddress": null,
"feePayerAddress": null,
"unfinalizedDate": "2022-11-28T15:43:20",
"useFeeDelegation": false,
"transactionCurrency": {
"krw": "1.00000000",
"usd": "1.00000000"
}
}
},
{
"webhookIdx": 637,
"webhookTargetIdx": 219563,
"webhookTargetDataScheme": "TRANSACTION_1",
"data": {
"memo": null,
"txid": "0xf4e7dbfc5a4a6082d81272d7b0d1c743f5dd9e88801a0c4018eed4c789066cfa",
"type": "GATHERING",
"uuid": "d50a18d4-31e6-4dc2-805c-df8c04232af1",
"nonce": 0,
"amount": "0.19995800000000000000",
"status": "FINALIZED",
"symbol": "ETH",
"usedFee": "0.00002100000021000000",
"toAddress": "0xD9a22a2627D5c1FfA0067A01f0333b18C697281b",
"failedDate": null,
"blockHeight": "8076445",
"createdDate": "2022-12-05T11:11:01",
"fromAddress": "0xe0b7103cba658BB3130577DE838C60F721ABA5d3",
"outputIndex": 0,
"toAddresses": [
"0xD9a22a2627D5c1FfA0067A01f0333b18C697281b"
],
"modifiedDate": "2022-12-05T11:12:01",
"finalizedDate": "2022-12-05T11:12:02",
"fromAddresses": [
"0xe0b7103cba658BB3130577DE838C60F721ABA5d3"
],
"contractAddress": null,
"feePayerAddress": null,
"unfinalizedDate": "2022-12-05T11:12:02",
"useFeeDelegation": false,
"transactionCurrency": {
"krw": null,
"usd": null
}
}
}
]



2. NFT deployment, minting, deposit, withdrawal​

[
{
"webhookIdx": 161,
"webhookTargetIdx": 189585,
"webhookTargetDataScheme": "NFT_TRANSACTION_1",
"data": {
"memo": null,
"txid": "0x0e4f2d9962ba557ab2c02154c06f5fe2ef2801d503994c1671040cae1f044174",
"type": "NFT_ITEM_CREATION",
"uuid": "80c7de5d-86f1-4bb7-8de4-4690008a2f31",
"nonce": 15,
"amount": "0",
"status": "FINALIZED",
"symbol": "WBHK",
"tokenId": null,
"usedFee": null,
"tokenUri": null,
"toAddress": "0x98Dd58da2a23f333Ab515e59217eDD1A78617360",
"failedDate": null,
"blockHeight": null,
"createdDate": "2022-06-23T10:18:50",
"fromAddress": "0xE291f46cC312c930a63f75F59341345551262821",
"outputIndex": null,
"toAddresses": [
"0xE291f46cC312c930a63f75F59341345551262821"
],
"modifiedDate": "2022-06-23T10:18:50",
"finalizedDate": "2022-06-23T10:18:50",
"fromAddresses": [
"0xE291f46cC312c930a63f75F59341345551262821"
],
"contractAddress": "0x98Dd58da2a23f333Ab515e59217eDD1A78617360",
"feePayerAddress": null,
"unfinalizedDate": "2022-06-23T10:18:50",
"useFeeDelegation": false
}
},
{
"webhookIdx": 164,
"webhookTargetIdx": 189586,
"webhookTargetDataScheme": "NFT_TRANSACTION_1",
"data": {
"memo": null,
"txid": "0x0e4f2d9962ba557ab2c02154c06f5fe2ef2801d503994c1671040cae1f044174",
"type": "DEPOSIT",
"uuid": "92ca7afd-4477-4e55-9c3b-83c8b61fda05",
"nonce": 15,
"amount": "1",
"status": "FINALIZED",
"symbol": null,
"tokenId": null,
"usedFee": "0.00026079300182555100",
"tokenUri": null,
"toAddress": "0xE291f46cC312c930a63f75F59341345551262821",
"failedDate": null,
"blockHeight": "7105992",
"createdDate": "2022-06-23T10:19:20",
"fromAddress": "0x0000000000000000000000000000000000000000",
"outputIndex": null,
"toAddresses": [
"0x0000000000000000000000000000000000000000"
],
"modifiedDate": "2022-06-23T10:19:20",
"finalizedDate": "2022-06-23T10:19:21",
"fromAddresses": [
"0x0000000000000000000000000000000000000000"
],
"contractAddress": null,
"feePayerAddress": null,
"unfinalizedDate": "2022-06-23T10:19:21",
"useFeeDelegation": false
}
},
......
]


3. Contract execution​

[
{
webhookIdx: 14,
webhookTargetIdx: 334,
webhookTargetDataScheme: 'TRANSACTION_2',
data: {
"data": {
"coin": {
"idx": 826,
"symbol": "USDC",
"contractAddress": "Gh9ZwEmdLJ8DscKNTkTqPbNwLNNBjuSzaG9Vp2KGtKJr"
},
"targetAddresses": [
"2o14JJNHDuVa2YkGy7riGyz1JjRMWs7N6VpVGqNCAgR8"
]
},
memo: null,
txid: '2mdMBunXUgfARYu6PpnSKLE41GMomLJY6CauoaC54rptJ3prHKR841dNyeMjjLoRVzrovX2NW8NbpCJbSApsr4fV',
type: 'CONTRACT_EXECUTION',
uuid: 'ba04da2f-663d-4df1-85fa-d41225278a5b',
nonce: null,
amount: '0.00000000000000000000',
method: 'createAta',
status: 'FINALIZED',
symbol: 'SOL',
usedFee: '0.00204428000000000000',
toAddress: 'Gh9ZwEmdLJ8DscKNTkTqPbNwLNNBjuSzaG9Vp2KGtKJr',
failedDate: null,
blockHeight: '463605518',
createdDate: '2026-05-20T05:16:36.344Z',
encodedData: '',
fromAddress: 'GGXUgthk1n3xyVnV8Ggc3dscM3xcJoMnwZyA2o8R4MKG',
outputIndex: 0,
toAddresses: [ 'Gh9ZwEmdLJ8DscKNTkTqPbNwLNNBjuSzaG9Vp2KGtKJr' ],
modifiedDate: '2026-05-20T05:21:20.298Z',
finalizedDate: '2026-05-20T05:21:20.000Z',
fromAddresses: [ 'GGXUgthk1n3xyVnV8Ggc3dscM3xcJoMnwZyA2o8R4MKG' ],
contractAddress: null,
feePayerAddress: null,
unfinalizedDate: '2026-05-20T05:21:20.000Z',
useFeeDelegation: false
}
}
]


Registering a webhook​


  1. Go to Console - select a wallet - [Wallet Settings] - [Webhook].
  2. Select the event to receive the webhook for, and enter the webhook's name and URL.
  3. Choose whether to enable integrity verification.
    1. After selecting enable, you can set it by entering the hash key value to use.
  4. When a specific event (deposit, withdrawal, etc.) occurs, data is sent to the registered URL.




Resending a webhook​

If receiving a webhook fails, you can resend the webhook from the console.

  1. Go to Console - select a wallet - [Webhook Log].
  2. Select the webhook to resend, then click the [Resend] button.
  3. The data is sent again to the registered URL.