支持订阅 project 维度下所有地址的交易事件,及交易相关数据。开启订阅后,会在具体交易事件产生时,进行 webhook 推送。
订阅接口需要提前做好以下技术准备,并有如下注意事项:
幂等 webhook 回调接口需要支持幂等
重试次数 如果我们没有收到成功的 HTTP 200 响应,我们会尝试重试 webhook,每次重试之间的延迟会增加。在最初的尝试之后,我们将进行最多 7 次额外的尝试。
重试间隔如下: 1、5、10、30、60、120、240 分钟
暂停推送 当出现以下任一情况时,将暂停发送通知:
POST https://www.okx.com/api/v5/waas/subscribe
Parameter | Type | Required | Description |
---|---|---|---|
url | String | Yes | webhook 回调的 URL |
type | String | Yes | TRANSACTION: 有任何地址相关的交易发生,都会触发 BLOCK_HEIGHT: 有任何区块产生,都会触发 |
chainId | String | no | 链唯一标识 |
Parameter | Type | Description |
---|---|---|
curl --location --request POST 'https://www.okx.com/api/v5/waas/subscribe' \
--header 'OK-ACCESS-PROJECT: 86af********d1bc' \
--header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \
--header 'OK-ACCESS-SIGN: leaV********3uw=' \
--header 'OK-ACCESS-PASSPHRASE: 1****6' \
--header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' \
--data '{
"callbackUrl":"http://your.server.com/webhook",
"type":"TRANSACTION"
}'
{
"code": 0,
"msg": "success",
"data": []
}