Webhooks - Corsair

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

emailStatus (emailStatus)
spamBlock (spamBlock)

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

Email Status

emailStatus Transactional email status events from UniOne Payload

Name	Type	Required	Description
`auth`	`string`	No	—
`events_by_user`	`object[]`	No	—

events_by_user full type

{
  user_id?: string | number,
  project_id?: string,
  project_name?: string,
  events?: {
    event_name: string,
    event_data?: {
      job_id?: string,
      email?: string,
      status?: string,
      event_time?: string
    }
  }[]
}[]

Response data full type

{
  auth?: string,
  events_by_user?: {
    user_id?: string | number,
    project_id?: string,
    project_name?: string,
    events?: {
      event_name: string,
      event_data?: {
        job_id?: string,
        email?: string,
        status?: string,
        event_time?: string
      }
    }[]
  }[]
}

webhookHooks example

unione({
    webhookHooks: {
        emailStatus: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

Spam Block

spamBlock SMTP spam-block events from UniOne Payload

Name	Type	Required	Description
`auth`	`string`	No	—
`events_by_user`	`object[]`	No	—

events_by_user full type

{
  user_id?: string | number,
  project_id?: string,
  project_name?: string,
  events?: {
    event_name: string,
    event_data?: {
      job_id?: string,
      email?: string,
      status?: string,
      event_time?: string
    }
  }[]
}[]

Response data full type

{
  auth?: string,
  events_by_user?: {
    user_id?: string | number,
    project_id?: string,
    project_name?: string,
    events?: {
      event_name: string,
      event_data?: {
        job_id?: string,
        email?: string,
        status?: string,
        event_time?: string
      }
    }[]
  }[]
}

webhookHooks example

unione({
    webhookHooks: {
        spamBlock: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Email Status

​Email Status

​Spam Block

​Spam Block

Webhook map

HTTP handler setup

Events

Email Status

Email Status

Spam Block

Spam Block