-
Notifications
You must be signed in to change notification settings - Fork 8
Add webhooks documentation for pre-recorded and streaming audio #575
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
devin-ai-integration
wants to merge
7
commits into
main
Choose a base branch
from
devin/1769285320-webhooks-pre-recorded-audio
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add webhooks documentation for pre-recorded and streaming audio #575
devin-ai-integration
wants to merge
7
commits into
main
from
devin/1769285320-webhooks-pre-recorded-audio
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com>
Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com>
Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com>
Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com>
Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com>
…ples Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
None yet
0 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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):
webhook_status_codefield documentation/docs/deployment/webhooksStreaming speech-to-text webhooks (new page):
pages/05-guides/webhooks-streaming.mdxwebhook_url,webhook_auth_header_name, andwebhook_auth_header_valueparameters for WebSocket connectionswss://streaming.assemblyai.com/v3/wsUpdates since last revision
webhook_status_codedocumentation to pre-recorded webhooks page explaining the field contains the HTTP status code received when calling the webhookReview & Testing Checklist for Human
webhook_status_codefield: Confirm this field exists in the transcript GET response and the description is accurateStreamingParametersfor Python,transcriberoptions for JS)webhook_url,webhook_auth_header_name, andwebhook_auth_header_valueare the actual parameter names for the v3 streaming WebSocket APIRecommended 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-checkand onelintjob) but these are due to pre-existing errors inopenapi.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