Revalidate Hook
Invalidate frontend cache when content changes
Usage
import { revalidateHook } from '@adsign/payload-adsign-plugin';
export const Pages: CollectionConfig = {
hooks: {
afterOperation: [
revalidateHook({
collection: 'pages',
cacheTagFields: ['slug'],
}),
],
},
};Options
| Option | Type | Description |
|---|---|---|
collection | string | Collection slug (required) |
cacheTagFields | string[] | Fields to use as cache tags |
collections | string[] | Additional collections to revalidate |
globals | string[] | Globals to revalidate |
documents | Document[] | Specific documents to revalidate |
revalidateRelationships | boolean | object | Revalidate related documents |
Examples
Revalidate with cache tag fields:
revalidateHook({
collection: 'articles',
cacheTagFields: ['slug'],
collections: ['articles'],
})Revalidate related documents (useful for media):
revalidateHook({
collection: 'media',
revalidateRelationships: true,
})Revalidate specific collections:
revalidateHook({
collection: 'media',
revalidateRelationships: {
collections: {
articles: true,
pages: true,
},
},
})Setup
- Configure in Payload:
adsignPlugin({
siteName: 'My Site',
domain: 'example.com',
revalidation: {
url: process.env.REVALIDATE_URL,
secret: process.env.REVALIDATE_SECRET,
},
})- Create API route in your frontend Next.js app:
import { revalidateTag } from 'next/cache';
import { NextRequest, NextResponse } from 'next/server';
export async function POST(request: NextRequest): Promise<Response> {
const { secret, tag } = await request.json();
if (secret !== process.env.REVALIDATE_SECRET) {
return NextResponse.json({ message: 'Invalid secret' }, { status: 401 });
}
revalidateTag(tag, 'max');
return NextResponse.json({ revalidated: true, now: Date.now() });
}