Overview

Webhooks enable your application to set up event based notifications. In this section, you’ll learn how to configure webhooks to receive updates from Fireflies.

Events supported

The webhooks support the following events:

  • Transcription complete: Triggers when a meeting has been processed and the transcript is ready for viewing

Saving a webhook

Follow the instructions below to save a webhook URL that sends notifications for all subscribed events. This webhook will only be fired for meetings that you own.

2

Navigate to the Developer settings tab
3

Enter a valid https URL in the webhooks field and save

You may test your webhook using the upload audio API or by uploading through the dashboard at app.fireflies.ai/upload

Upload audio webhook

You can also include a webhook URL as part of an upload audio request. This is different from the saved webhook as it will only send notifications for that singular audio upload request.

Webhook Schema

meetingId
String
required

Identifier for the meeting / transcript that the webhook has triggered for. MeetingId and TranscriptId are used interchangeably for the Fireflies.ai Platform.

eventType
String

Name of the event type that has been fired against the webhook

clientReferenceId
ID

Custom identifier set by the user during upload. You may use this to identify your uploads in your events.

Example Payload

{
    "meetingId": "ASxwZxCstx",
    "eventType": "Transcription completed",
    "clientReferenceId": "be582c46-4ac9-4565-9ba6-6ab4264496a8"
}

Additional Resources