Update Webhook

PATCH

You can modify the subscription condition of a Webhook, or activate or deactivate a Webhook.[확인 필요] Whether the condition of an ADDRESS_ACTIVITY Webhook can be changed to addressSetId (switching from listed addresses to an Address Set, or replacing the set) needs to be confirmed. The addressSetId field in the condition schema below is a definition shared with Create Webhook.

Path Parameters

chainstringrequired

Parameter specifying the target chain to query.

networkstringrequired

Parameter specifying the network of the target chain.

subscriptionIdstringrequired

Parameter to specify the subscriptionId assigned to the Webhook you want to query. You can use the subscriptionId returned when creating a Webhook to query, modify, and delete Webhook information.

Request Body

notificationobject

Parameter specifying the information required to receive notifications when an event occurs.

webhookUrlstring

Parameter specifying the webhook URL to receive notifications when the subscribed event occurs. A publicly accessible URL must be specified.

descriptionstring

Parameter specifying 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.

conditionobject

Field for defining detailed conditions of the events you want to subscribe to. Available conditions vary by event type, so refer to the Webhook Types page for usage.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.

addressesarray

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.

Responses

resultboolean

Field indicating the result of the call. Returns true on success and false on failure.

codestringrequired

Code identifying the cause of the failed request.

messagestringrequired

Detailed message including the name and value of the invalid parameter.

{
  "code": "MISSING_REQUIRED_PARAMETER",
  "message": "Missing required parameter: { PARAMETER_NAME }"
}

X-API-KEY

cURL

curl -X PATCH 'https://web3.nodit.io/v1/avalanche/mainnet/webhooks/5001' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo' \
  -d '{}'