Webhook events for the Fireflies.ai API
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.
The webhooks support the following events:
Fireflies sends webhook notifications as POST requests to your specified endpoint. Each request contains a JSON payload with information about the event that occurred.
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.
You may test your webhook using the upload audio API or by uploading through the dashboard at app.fireflies.ai/upload
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 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.
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.
Receive the Webhook:
x-hub-signature
headerVerify the Signature:
x-hub-signature
header valueBy verifying webhook signatures, consumers can ensure that webhook events received are secure and have not been altered during transmission
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.
Identifier for the meeting / transcript that the webhook has triggered for. MeetingId and TranscriptId are used interchangeably for the Fireflies.ai Platform.
Name of the event type that has been fired against the webhook
Custom identifier set by the user during upload. You may use this to identify your uploads in your events.
Why am I not receiving webhook requests
There may be multiple reasons why you are not receiving webhook requests. Please go through the following checklist:
organizer_email.
Ensure that you have correctly setup the webhooks for the meeting owner.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.
Webhook events for the Fireflies.ai API
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.
The webhooks support the following events:
Fireflies sends webhook notifications as POST requests to your specified endpoint. Each request contains a JSON payload with information about the event that occurred.
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.
You may test your webhook using the upload audio API or by uploading through the dashboard at app.fireflies.ai/upload
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 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.
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.
Receive the Webhook:
x-hub-signature
headerVerify the Signature:
x-hub-signature
header valueBy verifying webhook signatures, consumers can ensure that webhook events received are secure and have not been altered during transmission
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.
Identifier for the meeting / transcript that the webhook has triggered for. MeetingId and TranscriptId are used interchangeably for the Fireflies.ai Platform.
Name of the event type that has been fired against the webhook
Custom identifier set by the user during upload. You may use this to identify your uploads in your events.
Why am I not receiving webhook requests
There may be multiple reasons why you are not receiving webhook requests. Please go through the following checklist:
organizer_email.
Ensure that you have correctly setup the webhooks for the meeting owner.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.