Update Webhook

PATCH

You can modify the subscription condition of a Webhook, or activate or deactivate a 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 accounts included in a specified address array. 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.

addressesarrayrequired

List of addresses to monitor for events.

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 '{}'