Unsubscribe from transaction data#
Support for unsubscribing transaction-related data for all addresses in the project dimension. When you unsubscribe, you will no longer receive relevant webhook notifications.
Request URL#
POST https://www.okx.com/api/v5/waas/unsubscribe
Request parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
| url | String | Yes | URL for webhook callback |
| type | String | Yes | Currently supports TRANSACTION - any transaction related to any address will trigger, BLOCK_HEIGHT - any block generated will trigger |
| chainId | String | No | Unique identifier of the chain |
Response parameters#
| Parameter | Type | Description |
|---|---|---|
Request example#
shell
curl --location --request POST 'https://www.okx.com/api/v5/waas/unsubscribe' \
--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"
}'
Response example#
200
{
"code": "0",
"msg": "success",
"data": []
}