Webhooks - Corsair

The Gmail 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

messageChanged (messageChanged)

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

Message Changed

messageChanged A Gmail message was received, deleted, or had its labels changed 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: messageReceived,
  emailAddress: string,
  historyId: string,
  message: custom
} | {
  type: messageDeleted,
  emailAddress: string,
  historyId: string,
  message: custom
} | {
  type: messageLabelChanged,
  emailAddress: string,
  historyId: string,
  message: custom,
  labelsAdded?: string[],
  labelsRemoved?: string[]
}

webhookHooks example

gmail({
    webhookHooks: {
        messageChanged: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Message Changed

​Message Changed

Webhook map

HTTP handler setup

Events

Message Changed

Message Changed