Delete a webhook

DELETE/v1/webhooks/{id}API key

Deletes the webhook and every delivery record it has. This can't be undone. Deliveries still waiting in the queue are dropped when their turn comes, so nothing more is sent to the endpoint. To stop deliveries but keep the history, update the webhook with enabled: false instead.

Path parameters

idstringpathrequired

The webhook ID.

Response

idstring

The ID of the deleted webhook.

deletedtrue

Always true.

Errors

Status	Code	When
404	`webhook_not_found`	No webhook with this ID in the project.

Request

import { Flaresend } from '@flaresend/client';

const flaresend = new Flaresend({
  apiKey: process.env.FLARESEND_API_KEY!,
  baseUrl: 'https://mailer.example.com',
});

await flaresend.webhooks.remove('wh_01K6B3C8R2M5T7V9X1Z3B5D7F9');

Response

{
  "id": "wh_01K6B3C8R2M5T7V9X1Z3B5D7F9",
  "deleted": true
}

Path parametersCopy Anchor Link

ResponseCopy Anchor Link

ErrorsCopy Anchor Link

Path parameters

Response

Errors