Webhooks - Corsair

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

formResponse
- formResponse (formResponse.formResponse)

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

Form Response

formResponse.formResponse A new form response was submitted Payload

Name	Type	Required	Description
`eventId`	`string`	Yes	—
`eventType`	`FORM_RESPONSE`	Yes	—
`createdAt`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  responseId?: string,
  submissionId: string,
  respondentId?: string | null,
  formId: string,
  formName?: string,
  createdAt?: string,
  fields: {
    key: string,
    label?: string,
    type?: string,
    value?: any,
    options?: any[],
    rows?: any[],
    columns?: any[]
  }[]
}

Response data full type

{
  eventId: string,
  eventType: FORM_RESPONSE,
  createdAt: string,
  data: {
    responseId?: string,
    submissionId: string,
    respondentId?: string | null,
    formId: string,
    formName?: string,
    createdAt?: string,
    fields: {
      key: string,
      label?: string,
      type?: string,
      value?: any,
      options?: any[],
      rows?: any[],
      columns?: any[]
    }[]
  }
}

webhookHooks example

tally({
    webhookHooks: {
        formResponse: {
            formResponse: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Form Response

​Form Response

Webhook map

HTTP handler setup

Events

Form Response

Form Response