Skip to main content
WEBHOOK

Authorizations

Authorization
string
header
required

Your API key, sent bare. See Authentication.

Body

application/json
id
string

Stable typed event ID beginning with evt_. Use it to deduplicate retries.

type
enum<string>

The event type. Also sent in the X-HappyScribe-Event header.

  • bot.recording_started: the notetaker is in the call and recording.
  • bot.recording_completed: the call ended and the recording is available.
  • bot.transcript_ready: the transcript is ready.
  • bot.summary_ready: the summary is ready; the bot is completed.
  • bot.failed: the bot ended without a usable result.
  • bot.cancelled: the bot was cancelled.
Available options:
bot.recording_started,
bot.recording_completed,
bot.transcript_ready,
bot.summary_ready,
bot.failed,
bot.cancelled
created_at
string<date-time>

When MeetingKit emitted the event.

data
object

object: the bot, as GET /bots/{id} returns it.

Response

200

Return any 2xx status to acknowledge receipt. Any other status, or a timeout, triggers a retry — up to 21 attempts with backoff.