Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Jan 24, 2026

Summary

This PR updates the webhooks documentation to clearly distinguish between pre-recorded and streaming audio use cases:

Pre-recorded audio webhooks (existing page updated):

  • Updated page title from "Webhooks" to "Webhooks for pre-recorded audio"
  • Updated description and intro paragraph to reference pre-recorded audio
  • Added a Note component linking to the new streaming webhooks page
  • Removed C#, Ruby, and PHP code examples (keeping Python SDK, Python, JavaScript SDK, JavaScript)
  • Added webhook retry/failure behavior documentation
  • Added webhook_status_code field documentation
  • URL remains unchanged at /docs/deployment/webhooks

Streaming speech-to-text webhooks (new page):

  • Created new page at pages/05-guides/webhooks-streaming.mdx
  • Documents the webhook_url, webhook_auth_header_name, and webhook_auth_header_value parameters for WebSocket connections
  • Uses the v3 streaming endpoint: wss://streaming.assemblyai.com/v3/ws
  • Includes Python SDK, Python, JavaScript SDK, and JavaScript code examples with microphone streaming
  • Includes webhook payload example with field documentation
  • Added webhook retry/failure behavior documentation
  • Covers webhook authentication and best practices
  • Added to navigation in the Deployment section

Updates since last revision

  • Added Python SDK and JavaScript SDK code examples to streaming webhooks page (tab order: Python SDK, Python, JavaScript SDK, JavaScript)
  • Removed C#, Ruby, and PHP code examples from pre-recorded webhooks page
  • Added webhook retry/failure behavior to both pages: 2xx response expected within 10 seconds, up to 10 retry attempts, 4xx status causes immediate failure without retry
  • Added webhook_status_code documentation to pre-recorded webhooks page explaining the field contains the HTTP status code received when calling the webhook

Review & Testing Checklist for Human

  • Verify webhook retry behavior: Confirm the retry logic is accurate (2xx expected within 10 seconds, up to 10 total attempts, 4xx = immediate failure)
  • Verify webhook_status_code field: Confirm this field exists in the transcript GET response and the description is accurate
  • Verify SDK examples are correct: Check that the Python SDK and JavaScript SDK examples use the correct API for webhook parameters (StreamingParameters for Python, transcriber options for JS)
  • Verify webhook payload structure: Confirm the example JSON payload matches what the streaming API actually sends to webhooks
  • Verify streaming webhook parameters are correct: Confirm that webhook_url, webhook_auth_header_name, and webhook_auth_header_value are the actual parameter names for the v3 streaming WebSocket API

Recommended test plan: Navigate to both webhook pages in the docs preview, verify the navigation shows both pages, test the cross-links between them, and compare the webhook payload example against actual API responses.

Notes

CI shows some failing checks (fern-check and one lint job) but these are due to pre-existing errors in openapi.yml (array-items validation errors) unrelated to this PR. The lint and run checks for the documentation changes passed. The checks are not marked as required.

Requested by: @LeeVaughn
Devin session: https://app.devin.ai/sessions/e06e86841a1e41ee8d3f78f5774ea879

Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link

Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com>
@github-actions
Copy link

Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com>
@github-actions
Copy link

@devin-ai-integration devin-ai-integration bot changed the title Update webhooks page to clarify it's for pre-recorded audio Add webhooks documentation for pre-recorded and streaming audio Jan 28, 2026
Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com>
@github-actions
Copy link

Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com>
@github-actions
Copy link

Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com>
@github-actions
Copy link

…ples

Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com>
@github-actions
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants