PATCHUpdate Webhook

Webhook APIhttps://web3.nodit.io/v1/aptos/mainnet/webhooks/5001

You can modify the subscription condition of a Webhook, or activate or deactivate a Webhook.

For an ADDRESS_ACTIVITY Webhook, the way monitored addresses are specified (addresses or addressSetId) and the attached Address Set cannot be changed after creation. A Webhook created with addresses can only change the address list in addresses, and a Webhook created with addressSetId cannot be switched to another set or to addresses. Attempting to do so returns 409 ADDRESS_SET_BINDING_IMMUTABLE; to change the method or the set, create a new Webhook. To change the monitored addresses of a Webhook attached to a set, modify the addresses of the set through the Address Set API. Even for a Webhook created with addresses, if another Webhook also reads its address list via addressSetId, addresses cannot be changed and 409 ADDRESS_SET_MANAGED is returned. In that case as well, modify the addresses through the Address Set API.

chainstring (enum)required

Parameter to specify the target chain for the query.

networkstring (enum)required

Parameter to specify the network of the target chain. Supported networks may vary depending on the chain.

subscriptionIdstringrequired

Parameter that specifies the subscriptionId assigned to the Webhook to query. Use the subscriptionId returned when creating the Webhook to query, update, or delete Webhook information.

webhookUrlstring

Parameter that specifies the webhook URL to receive notifications when subscribed events occur. Must be a publicly accessible URL.

descriptionstring

Parameter that specifies the description of the event.

isActiveboolean

Parameter specifying whether the Webhook is active. When set to true, the Webhook is activated; when set to false, it is deactivated. A deactivated Webhook cannot receive notifications but is not deleted.

conditiononeOf

oneOf

Monitors activity of the addresses you specify. This event sends a notification whenever these accounts are involved as either sender (from) or recipient (to) in a transaction, i.e., when a transaction, token transfer (ERC20), or NFT transfer (ERC721, ERC1155) occurs. This service enables users to track activity across multiple addresses in real time and effectively monitor asset movements and transactions. Provide the monitored addresses in exactly one of two ways, either listing them directly in addresses or specifying the addressSetId of a set created in advance with the Address Set API. Providing both returns 400 INVALID_PARAMETER, and providing neither returns 400 MISSING_REQUIRED_PARAMETER.

addressesstring (^0[xX][0-9a-fA-F]{40}$)[]

List of addresses to monitor for events. Cannot be used together with addressSetId.

addressSetIdstring

The addressSetId of the Address Set whose addresses are to be monitored. Specify a set created in advance with the Address Set API; it cannot be used together with addresses. The set must be in READY status (otherwise 409 ADDRESS_SET_NOT_READY), and its addressFormat must match the chain's address format (otherwise 422 ADDRESS_SET_FORMAT_MISMATCH). Specifying a set that does not exist, or that belongs to another account or another project, returns 404 RESOURCE_NOT_FOUND. Pass the 19-digit number as a string.

resultboolean

Field representing the call result. Returns true on success, false on failure.