Description

Delete the provided webhook.

Parameters

Response

Example Request and Response

Prerequisite: You will need to install the Alchemy SDK before making requests with it.

The commands for installing it using npm or yarn are given below:

$
npm install alchemy-sdk@latest

Request

1
// Setup: npm install alchemy-sdk
2
// Github: https://github.com/alchemyplatform/alchemy-sdk-js
3
import { Alchemy, Network, WebhookType } from "alchemy-sdk";
4
5
// authToken is required to use Notify APIs. Found on the top right corner of
6
// https://dashboard.alchemy.com/notify.
7
const settings = {
8
  authToken: "your-notify-auth-token",
9
  network: Network.ETH_MAINNET, // Replace with your network.
10
};
11
12
const alchemy = new Alchemy(settings);
13
14
const minedTxWebhook = await alchemy.notify.createWebhook(
15
  "https://webhook.site/your-webhook-url",
16
  WebhookType.MINED_TRANSACTION,
17
  { appId: "wq9fgv022aff81pg" }
18
);
19
20
//Perform deletion of Webhooks
21
const deleteViaWebhookID = await alchemy.notify.deleteWebhook("wh_qv16bt12wbj9kax4");
22
const deleteMinedTxWebhook = await alchemy.notify.deleteWebhook(minedTxWebhook);

Response

1
{}

Use Cases

Here are some potential use cases for the deleteWebhook method:

• Updating webhook settings: If you need to update the URL or other settings of a webhook, you can delete the existing webhook using thedeleteWebhook method and then create a new one with the updated settings using createWebhook.

• Removing unused webhooks: If you have created a webhook that is no longer needed, you can delete it using deleteWebhook to clean up your API and reduce clutter.

• Resolving issues with a webhook: If you are experiencing issues with a webhook, deleting it and creating a new one can help resolve the issue.

• Revoking access: If you need to revoke access to your API for a particular webhook, you can delete it using deleteWebhook.

Related Methods

• createWebhook - Create a new Webhook to track transactions sent by the app associated with the app id.
• updateWebhook - Update a webhook address.