Webhooks - Corsair

The tl;dv 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

meetings
- meetingReady (meetings.meetingReady)
transcripts
- transcriptReady (transcripts.transcriptReady)

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

Meetings

Meeting Ready

meetings.meetingReady A meeting finished processing. Carries its notes when they exist, and its transcript when the subscription includes one Payload

Name	Type	Required	Description
`id`	`string`	Yes	Webhook delivery id
`event`	`MeetingReady`	Yes	—
`data`	`object`	Yes	—
`executedAt`	`string \| null`	No	ISO 8601 timestamp

data full type

{
  id: string,
  name: string,
  happenedAt: string,
  url: string,
  duration: number,
  organizer: {
    name?: string | null,
    email: string
  },
  invitees: {
    name?: string | null,
    email: string
  }[],
  template?: {
    id?: string | null,
    label?: string | null
  } | null,
  extraProperties?: {
    conferenceId?: string | null
  } | null,
  phoneNumber?: string | null,
  metadata?: Record<string, any> | null,
  notes?: {
    markdownContent?: string | null,
    structuredNotes?: {
      segmentId?: string | null,
      timestamp: number,
      text?: string | null,
      topicId?: string | null
    }[] | null,
    topics?: {
      id: string,
      order: number,
      title: string,
      summary?: string | null
    }[] | null
  } | null,
  transcript?: {
    id: string,
    meetingId: string,
    data: {
      speaker: string,
      text: string,
      startTime: number,
      endTime: number
    }[]
  } | null
}

Response data full type

{
  id: string,
  event: MeetingReady,
  data: {
    id: string,
    name: string,
    happenedAt: string,
    url: string,
    duration: number,
    organizer: {
      name?: string | null,
      email: string
    },
    invitees: {
      name?: string | null,
      email: string
    }[],
    template?: {
      id?: string | null,
      label?: string | null
    } | null,
    extraProperties?: {
      conferenceId?: string | null
    } | null,
    phoneNumber?: string | null,
    metadata?: Record<string, any> | null,
    notes?: {
      markdownContent?: string | null,
      structuredNotes?: {
        segmentId?: string | null,
        timestamp: number,
        text?: string | null,
        topicId?: string | null
      }[] | null,
      topics?: {
        id: string,
        order: number,
        title: string,
        summary?: string | null
      }[] | null
    } | null,
    transcript?: {
      id: string,
      meetingId: string,
      data: {
        speaker: string,
        text: string,
        startTime: number,
        endTime: number
      }[]
    } | null
  },
  executedAt?: string | null
}

webhookHooks example

tldv({
    webhookHooks: {
        meetings: {
            meetingReady: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Transcripts

Transcript Ready

transcripts.transcriptReady A meeting transcript has been generated Payload

Name	Type	Required	Description
`id`	`string`	Yes	Webhook delivery id
`event`	`TranscriptReady`	Yes	—
`data`	`object`	Yes	—
`executedAt`	`string \| null`	No	ISO 8601 timestamp

data full type

{
  id: string,
  meetingId: string,
  data: {
    speaker: string,
    text: string,
    startTime: number,
    endTime: number
  }[]
}

Response data full type

{
  id: string,
  event: TranscriptReady,
  data: {
    id: string,
    meetingId: string,
    data: {
      speaker: string,
      text: string,
      startTime: number,
      endTime: number
    }[]
  },
  executedAt?: string | null
}

webhookHooks example

tldv({
    webhookHooks: {
        transcripts: {
            transcriptReady: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Meetings

​Meeting Ready

​Transcripts

​Transcript Ready

Webhook map

HTTP handler setup

Events

Meetings

Meeting Ready

Transcripts

Transcript Ready