Webhooks

Retrieve a webhook

One webhook by ID, without its secret.

GET/v1/webhooks/{id}API key

The secret is never returned here. If you lost it, rotate it to get a new one.

Path parameters

idstringpathrequired

The webhook ID, for example wh_01K6B3C8R2M5T7V9X1Z3B5D7F9.

Response

idstring

The webhook ID.

projectIdstring

The project the webhook belongs to.

urlstring

The endpoint URL.

eventsstring[]

The subscribed event types. "*" means all.

enabledboolean

Whether the webhook receives events.

createdAtstring

ISO 8601 timestamp.

updatedAtstring

ISO 8601 timestamp.

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',
});

const webhook = await flaresend.webhooks.get('wh_01K6B3C8R2M5T7V9X1Z3B5D7F9');

Response

{
  "id": "wh_01K6B3C8R2M5T7V9X1Z3B5D7F9",
  "projectId": "proj_01K6A9W2E4R6T8Y0U2I4O6P8A0",
  "url": "https://acme.com/webhooks/flaresend",
  "events": ["email.delivered", "email.bounced", "email.complained"],
  "enabled": true,
  "createdAt": "2026-09-26T10:00:00.000Z",
  "updatedAt": "2026-09-26T10:00:00.000Z"
}

List webhooksGET

Every webhook in the project, oldest first.

Update a webhookPATCH

Change a webhook's URL, events, or turn it on and off.