Edit Webhook

Programatically edit a Helius webhook.

Note: It may take up to 2 minutes for webhook changes to take effect!

PUT /webhooks/:webhookID

Edits a webhook.

put

/v0/webhooks/{webhookID}

Authorizations

Path parameters

webhookIDstringrequired

The webhook ID.

Query parameters

api-keystringrequired

The api key.

Body

webhookURLstring

webhookTypestring

authHeaderstring

txnStatusstring · enum

Options: all, success, failed

transactionTypesstring · enum[]

accountAddressesstring[]

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.helius.xyz/v0/webhooks/{webhookID}?api-key=text' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"txnStatus":"all","transactionTypes":["UNKNOWN"],"accountAddresses":[null]}'

200

400

401

403

404

429

500

200

{
  "webhookID": "text",
  "wallet": "text",
  "webhookURL": "text",
  "webhookType": "text",
  "authHeader": "text",
  "txnStatus": "all",
  "transactionTypes": [
    "UNKNOWN"
  ],
  "accountAddresses": [
    "text"
  ]
}

The edited webhook.

Code Example

const editWebhook = async () => {
  try {
    const response = await fetch(
      "https://api.helius.xyz/v0/webhooks/<webhook-id>?api-key=<api-key>",
      {
        method: 'PUT',
        headers: {
          'Content-Type': 'application/json',
        },
        body: JSON.stringify({
          webhookURL: "https://typedwebhook.tools/webhook/dfb45a88-c361-4c06-84d8-e728588b8907",
          transactionTypes: [
            "Any"
          ],
          accountAddresses: [
            "2k5AXX4guW9XwRQ1AKCpAuUqgWDpQpwFfpVFh3hnm2Ha"
          ],
          webhookType: "enhanced"
        }),
      }
    );
    const data = await response.json();
    console.log({ data });
  } catch (e) {
    console.error("error", e);
  }
};
editWebhook();