Webhooks

Each workspace has a single configurable webhook URL. Whenever content changes (post publish/unpublish, navigation save, workspace config edit), Brandfine fires a POST to that URL so consumer sites can invalidate caches.

Configuration

1. CMS → Workspace → Settings → Publish notifier.
2. URL format:

   https://your-site.example/api/brandfine-webhook?secret=<long-random-string>

3. The secret query param is shared with Brandfine. The consumer's webhook handler verifies it with constant-time comparison.

Payload

POST /your-webhook-url?secret=<your-secret>
Content-Type: application/json
User-Agent: Brandfine-Notifier/1

{
  "event": "post.published",
  "workspaceId": "ws_2N4r",
  "postId": "p_2N4r",
  "slug": "schengen-visa",
  "title": "Schengen Visa",
  "publishedAt": "2026-03-12T08:00:00.000Z",
  "at": "2026-03-12T08:00:01.123Z"
}

Event types

Future event names are added without versioning the payload — consumers should accept unknown event strings (the SDK's BrandfineWebhookEvent type uses string with the known union for autocomplete).

Response semantics

SDK

import { createBrandfineWebhookHandler } from '@brandfine/client/webhook'

export const POST = createBrandfineWebhookHandler({
  secret: process.env.BRANDFINE_WEBHOOK_SECRET!,
  onEvent: ({ event, key }) => {
    postsCache.invalidate()
    if (event.startsWith('navigation.'))
      navigationsCache.invalidate(key ?? undefined)
  },
})

The handler verifies the secret, parses the body, calls your onEvent, and returns the right HTTP code automatically. See SDK → Webhooks.