Happy Scribe webhooks

The Happy Scribe 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
- cancelled (meetings.cancelled)
- failed (meetings.failed)
- recordingCompleted (meetings.recordingCompleted)
- recordingStarted (meetings.recordingStarted)
- summaryReady (meetings.summaryReady)
- transcriptReady (meetings.transcriptReady)
other
- other (other.other)

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

Cancelled

meetings.cancelled The Meeting was cancelled before completion Payload

Name	Type	Required	Description
`id`	`string`	Yes	Event ID beginning with `evt_`; deduplicate retries on it.
`type`	`string`	Yes	Event type, e.g. `meeting.summary_ready`.
`created_at`	`string \| null`	No	—
`data`	`object`	Yes	—

data full type

{
  object: Record<string, any>
}

Response data full type

{
  id: string,
  type: string,
  created_at?: string | null,
  data: {
    object: Record<string, any>
  }
}

webhookHooks example

happyscribe({
    webhookHooks: {
        meetings: {
            cancelled: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Failed

meetings.failed The notetaker or transcription flow reached a terminal failure Payload

Name	Type	Required	Description
`id`	`string`	Yes	Event ID beginning with `evt_`; deduplicate retries on it.
`type`	`string`	Yes	Event type, e.g. `meeting.summary_ready`.
`created_at`	`string \| null`	No	—
`data`	`object`	Yes	—

data full type

{
  object: Record<string, any>
}

Response data full type

{
  id: string,
  type: string,
  created_at?: string | null,
  data: {
    object: Record<string, any>
  }
}

webhookHooks example

happyscribe({
    webhookHooks: {
        meetings: {
            failed: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Recording Completed

meetings.recordingCompleted The provider recording is available for processing Payload

Name	Type	Required	Description
`id`	`string`	Yes	Event ID beginning with `evt_`; deduplicate retries on it.
`type`	`string`	Yes	Event type, e.g. `meeting.summary_ready`.
`created_at`	`string \| null`	No	—
`data`	`object`	Yes	—

data full type

{
  object: Record<string, any>
}

Response data full type

{
  id: string,
  type: string,
  created_at?: string | null,
  data: {
    object: Record<string, any>
  }
}

webhookHooks example

happyscribe({
    webhookHooks: {
        meetings: {
            recordingCompleted: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Recording Started

meetings.recordingStarted The notetaker entered the call and recording started Payload

Name	Type	Required	Description
`id`	`string`	Yes	Event ID beginning with `evt_`; deduplicate retries on it.
`type`	`string`	Yes	Event type, e.g. `meeting.summary_ready`.
`created_at`	`string \| null`	No	—
`data`	`object`	Yes	—

data full type

{
  object: Record<string, any>
}

Response data full type

{
  id: string,
  type: string,
  created_at?: string | null,
  data: {
    object: Record<string, any>
  }
}

webhookHooks example

happyscribe({
    webhookHooks: {
        meetings: {
            recordingStarted: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Summary Ready

meetings.summaryReady The plain-text meeting summary has been generated and persisted Payload

Name	Type	Required	Description
`id`	`string`	Yes	Event ID beginning with `evt_`; deduplicate retries on it.
`type`	`string`	Yes	Event type, e.g. `meeting.summary_ready`.
`created_at`	`string \| null`	No	—
`data`	`object`	Yes	—

data full type

{
  object: Record<string, any>
}

Response data full type

{
  id: string,
  type: string,
  created_at?: string | null,
  data: {
    object: Record<string, any>
  }
}

webhookHooks example

happyscribe({
    webhookHooks: {
        meetings: {
            summaryReady: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Transcript Ready

meetings.transcriptReady The full JSON transcript is ready Payload

Name	Type	Required	Description
`id`	`string`	Yes	Event ID beginning with `evt_`; deduplicate retries on it.
`type`	`string`	Yes	Event type, e.g. `meeting.summary_ready`.
`created_at`	`string \| null`	No	—
`data`	`object`	Yes	—

data full type

{
  object: Record<string, any>
}

Response data full type

{
  id: string,
  type: string,
  created_at?: string | null,
  data: {
    object: Record<string, any>
  }
}

webhookHooks example

happyscribe({
    webhookHooks: {
        meetings: {
            transcriptReady: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Other

other.other HappyScribe delivery whose event type this plugin has no dedicated handler for; check type before acting Payload

Name	Type	Required	Description
`id`	`string`	Yes	Event ID beginning with `evt_`; deduplicate retries on it.
`type`	`string`	Yes	Event type, e.g. `meeting.summary_ready`.
`created_at`	`string \| null`	No	—
`data`	`object`	Yes	—

data full type

{
  object: Record<string, any>
}

Response data full type

{
  id: string,
  type: string,
  created_at?: string | null,
  data: {
    object: Record<string, any>
  }
}

webhookHooks example

happyscribe({
    webhookHooks: {
        other: {
            other: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Meetings

​Cancelled

​Failed

​Recording Completed

​Recording Started

​Summary Ready

​Transcript Ready

​Other

​Other

Webhook map

HTTP handler setup

Events

Meetings

Cancelled

Failed

Recording Completed

Recording Started

Summary Ready

Transcript Ready

Other

Other