Webhooks - Corsair

The Google Docs plugin handles incoming webhooks. Point your provider’s subscription URL at your Corsair HTTP handler (see Overview for setup context and the exact URL shape).

New to Corsair? See webhooks and hooks.

Webhook map

docChanged (docChanged)

HTTP handler setup

app/api/webhook/route.ts

import { processWebhook } from "corsair";
import { corsair } from "@/server/corsair";

export async function POST(request: Request) {
    const headers = Object.fromEntries(request.headers);
    const body = await request.json();
    const result = await processWebhook(corsair, headers, body);
    return result.response;
}

Events

Doc Changed

docChanged A Google Doc was created, updated, deleted, or matched a content trigger Payload

Name	Type	Required	Description
`message`	`object`	No	—
`subscription`	`string`	No	—
`event`	`any`	No	—

message full type

{
  data?: string,
  attributes?: {
  },
  messageId?: string,
  publishTime?: string
}

Response data full type

{
  type: documentCreated | documentAdded | documentUpdated | documentDeleted | documentStructureChanged | keywordDetected | documentWordCountThreshold | documentPlaceholderFilled | documentSearchUpdate | folderCreated,
  documentId?: string,
  title?: string,
  changeType?: created | updated | deleted | trashed,
  matchedValue?: string,
  wordCount?: number,
  structure?: {
    headers: number,
    footers: number,
    footnotes: number,
    tables: number,
    images: number,
    positionedObjects: number,
    namedRanges: number
  },
  document?: custom
}

webhookHooks example

googledocs({
    webhookHooks: {
        docChanged: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

Database

Overview

​Webhook map

​HTTP handler setup

​Events

​Doc Changed

​Doc Changed

Webhook map

HTTP handler setup

Events

Doc Changed

Doc Changed