Webhooks - Corsair

The Zoho Mail 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

challenge
- handshake (challenge.handshake)
messages
- received (messages.received)

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

Challenge

Handshake

challenge.handshake Zoho Mail initial webhook handshake via x-hook-secret header Payload: empty object

Response data full type

{
  hookSecret: string
}

webhookHooks example

zohomail({
    webhookHooks: {
        challenge: {
            handshake: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Messages

Received

messages.received A new email was received in the mailbox Payload

Name	Type	Required	Description
`messageId`	`string`	No	—
`folderId`	`string`	No	—
`subject`	`string`	No	—
`summary`	`string`	No	—
`html`	`string`	No	—
`fromAddress`	`string`	No	—
`toAddress`	`string`	No	—
`ccAddress`	`string`	No	—
`sender`	`string`	No	—
`sentDateInGMT`	`string`	No	—
`receivedTime`	`string`	No	—
`size`	`string \| number`	No	—

Response data full type

{
  messageId?: string,
  folderId?: string,
  subject?: string,
  summary?: string,
  html?: string,
  fromAddress?: string,
  toAddress?: string,
  ccAddress?: string,
  sender?: string,
  sentDateInGMT?: string,
  receivedTime?: string,
  size?: string | number
}

webhookHooks example

zohomail({
    webhookHooks: {
        messages: {
            received: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Challenge

​Handshake

​Messages

​Received

Webhook map

HTTP handler setup

Events

Challenge

Handshake

Messages

Received