API Reference

Delete Webhook

DELETE /webhooks/:id — remove a webhook.

DELETE/webhooks/:id

Permanently removes a webhook. MailBlastr stops delivering events to its endpoint immediately.

Path parameters

idstringrequired

The webhook id as returned by Create Webhook or List Webhooks — a numeric string (e.g. 17), not a UUID. A non-numeric id returns not_found (404).

import { Mailblastr } from 'mailblastr';

const mb = new Mailblastr('mb_xxxxxxxxx');

const { data, error } = await mb.webhooks.remove('17');
console.log({ data, error });

Response

{
  "object": "webhook",
  "id": "17",
  "deleted": true
}

Errors: not_found if the webhook does not exist or is not yours. See Errors.