Speak AI Webhooks
Overview
Speak AI Webhooks allow you to receive real-time updates about your recordings as they happen. Imagine getting instant notifications when a recording is ready for review or when its analysis is complete. This means you can automate your workflows and get the insights you need faster, without constantly checking your dashboard.
You can configure these notifications to include rich details like the questions asked, the answers provided, and direct links to your media files. This makes it easy to integrate Speak AI data into your existing systems and build powerful custom solutions.
How It Works
When an event occurs in Speak AI, like a recording being transcribed or analyzed, Speak AI sends a POST request to a URL you specify. This request contains all the relevant data about the event.
You simply need to register a callback URL in the Integrations menu. Speak AI will then send event data, including details like the media ID, the prompt (question), the answer, and the media status.
Getting Started
To access this feature, go to Side navigation > Developers > Webhooks in your dashboard.
Configuration
Follow these steps to set up your webhooks:
Navigate to Integrations: Go to
Dashboard > Integrations > Webhooks.Create New Webhook: Click Add Webhook.
Set Callback URL: Enter the secure HTTPS URL where you want to receive data.
Select Events: Choose the events you want to be notified about, such as
media.createdormedia.processed.
When the media.processed event fires, the payload will include insight data, which contains question-answer pairs if you're using the Meeting Assistant or Magic Prompts. The sourceUrl or audio_url field will provide the link to the MP3 file.
Examples
Here's an example of what the payload might look like when a media file is processed:
{
"eventType": "media.processed",
"mediaId": "...",
"data": {
"insight": { ... },
"sourceUrl": "https://.../file.mp3"
}
}
Troubleshooting
No Data Received: If you're not receiving data, ensure your endpoint returns a 200 OK status immediately. Timeouts can cause retries or failures.
Next Steps
Ready to get started? Here's what to do next:
Login to your account and navigate to
Dashboard > Integrations > Webhooks.Configure your webhook with a callback URL and select the events you want to track.
Test your integration using a service like Webhook.site before connecting to your live system.
Need help? Contact our support team or check out our other guides.