Skip to main content

Method Signature

align.webhooks.delete(id: string): Promise<void>

Parameters

id
string
required
The unique webhook identifier (e.g., wh_abc123)

Returns

Returns void on success (no response body).

Examples

import Align from "@tolbel/align";

const align = new Align({
  apiKey: process.env.ALIGN_API_KEY!,
  environment: "sandbox",
});

// Delete a webhook
await align.webhooks.delete("wh_123e4567-e89b-12d3-a456-426614174000");

console.log("Webhook deleted successfully");

Delete All Webhooks

// Get all webhooks and delete them
const response = await align.webhooks.list();

for (const webhook of response.items) {
  await align.webhooks.delete(webhook.webhook_id);
  console.log(`Deleted: ${webhook.url}`);
}

console.log("All webhooks deleted");

Error Handling

import { AlignError } from "@tolbel/align";

try {
  await align.webhooks.delete("wh_nonexistent");
} catch (error) {
  if (error instanceof AlignError) {
    if (error.statusCode === 404) {
      console.error("Webhook not found");
    } else {
      console.error(`Failed to delete: ${error.message}`);
    }
  }
}
Webhook deletion is permanent and cannot be undone. Make sure you want to stop receiving events before deleting.