Webhooks

Webhooks are custom HTTP callbacks that you can define to get notified when your transcripts are ready.

To use webhooks, you need to set up your own webhook receiver to handle webhook deliveries.

Create a webhook for a transcription

1
import assemblyai as aai
2
3
aai.settings.api_key = "<YOUR_API_KEY>"
4
5
# audio_file = "./local_file.mp3"
6
audio_file = "https://assembly.ai/wildfires.mp3"
7
8
config = aai.TranscriptionConfig().set_webhook("https://example.com/webhook")
9
10
aai.Transcriber().submit(audio_file, config)

Handle webhook deliveries

When the transcript is ready, AssemblyAI will send a POST HTTP request to the URL that you specified.

Delivery payload

The webhook delivery payload contains a JSON object with the following properties:

1
{
2
  "transcript_id": "5552493-16d8-42d8-8feb-c2a16b56f6e8",
3
  "status": "completed"
4
}

Retrieve a transcript with the transcript ID

1
transcript = aai.Transcript.get_by_id("<TRANSCRIPT_ID>")

Authenticate webhook deliveries

You can authenticate webhook deliveries from AssemblyAI by including a custom HTTP header in the request.

1
config = aai.TranscriptionConfig().set_webhook(
2
    "https://example.com/webhook", "X-My-Webhook-Secret", "secret-value"
3
)
4
5
aai.Transcriber().submit(audio_url, config)

Add metadata to webhook deliveries

To associate metadata for a specific transcription request, you can add your own query parameters to the webhook URL.

1
https://example.com/webhook?customer_id=1234&order_id=5678

Now, when you receive the webhook delivery, you’ll know the customer who requested it.

Handling failed webhook deliveries

Webhook deliveries can fail for multiple reasons. For example, if your server is down or takes more than 10 seconds to respond.

If a webhook delivery fails, AssemblyAI will attempt to redeliver it up to 10 times, waiting 10 seconds between each attempt. If all attempts fail, AssemblyAI considers the delivery as permanently failed.