Skip to main content

Overview

Webhooks enable your application to set up event based notifications. This page documents the legacy (V1) webhook, configured from the dashboard Developer settings.
Webhooks V1 is deprecated. The webhook field in Settings → Developer settings is now read-only: existing webhooks keep being delivered, but new webhooks must be created with Webhooks V2, which supports multiple events and granular event subscriptions.

Events supported

The webhooks support the following events:
  • Transcription complete: Triggers when a meeting has been processed and the transcript is ready for viewing
Fireflies sends webhook notifications as POST requests to your specified endpoint. Each request contains a JSON payload with information about the event that occurred.

Saving a webhook

A V1 webhook URL sends notifications for all subscribed events, and is only fired for meetings that you own. New V1 webhooks can no longer be saved. To create a webhook, use the Webhooks V2 page - see Webhooks V2. If you already have a V1 webhook, you can review it in Settings → Developer settings → Webhook → View Configuration, where you can also disable it before recreating it in V2. You may test an existing 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 Authentication

Webhook authentication ensures that incoming webhook requests are securely verified before processing. This allows consumers to trust that webhook events originate from a secure and verified source.

How It Works

Each webhook request sent from the server includes an x-hub-signature header containing a SHA-256 HMAC signature of the request payload. This signature is generated using a secret key known only to the server and your application. When the consumer receives a webhook, they can use the signature provided in the x-hub-signature header to verify that the request has not been tampered with. This is done by computing their own HMAC signature using the shared secret key and comparing it to the signature included in the header.

Saving a secret

The secret key of an existing V1 webhook can be viewed in Settings → Developer Settings → Webhook → View Configuration, but it can no longer be changed there. Set a Signing Secret on the Webhooks V2 page instead. Store the secret key securely, as it is used to authenticate incoming webhook requests.

Verifying the Signature

  1. Receive the Webhook:
    • Each request will include the payload and an x-hub-signature header
  2. Verify the Signature:
    • Compute the HMAC SHA-256 signature using the payload and the shared secret key
    • Compare the computed signature to the x-hub-signature header value
    • If they match, the request is verified as authentic. If they do not match, treat the request with caution or reject it
By verifying webhook signatures, consumers can ensure that webhook events received are secure and have not been altered during transmission

See it in action

To see webhook authentication in action, you can view an example at Fireflies.ai Verifying Webhook Requests. This example demonstrates how to receive a webhook, compute the HMAC SHA-256 signature, and verify it against the x-hub-signature header to ensure the request’s authenticity.

Webhook Schema

String
required
Identifier for the meeting / transcript that the webhook has triggered for. MeetingId and TranscriptId are used interchangeably for the Fireflies.ai Platform.
String
Name of the event type that has been fired against the webhook
ID
Custom identifier set by the user during upload. You may use this to identify your uploads in your events.

Example Payload

FAQ

There may be multiple reasons why you are not receiving webhook requests. Please go through the following checklist:

  • Webhooks are only fired for meeting owners, referred to in the API as the organizer_email. Ensure that you have correctly setup the webhooks for the meeting owner.
  • Ensure that your webhook is setup as a POST request
  • If you have setup secret verification, ensure that you are correctly verifying the request by checking the example implementation here.

Team-wide webhooks are only supported for the Enterprise tier with the Super Admin role. This allows you to setup one webhook for all meetings owned by your team. Details here.

Additional Resources

Webhooks V2

The current webhook system - events, retries and signatures

Super Admin

Fireflies Super Admin with advanced capabilities

Upload Audio

Use the API to upload audio to Fireflies.ai