Webhooks - Corsair

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

events
- delivery (events.delivery)

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

Delivery

events.delivery Signed call and SMS deliveries. The handler confirms the resource with the API before returning success. Payload

Name	Type	Required	Description
`deliveryId`	`string`	Yes	—
`eventType`	`string`	Yes	—
`payload`	`object`	Yes	—

payload full type

{
  callId?: string,
  messageId?: string,
  numberId?: string
}

Response data full type

{
  eventType: string,
  deliveryId: string,
  resource: {
  }
}

webhookHooks example

saperly({
    webhookHooks: {
        events: {
            delivery: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Events

​Delivery

Webhook map

HTTP handler setup

Events

Events

Delivery