docs(langsmith): add Engine webhook events reference#4008
Draft
Andy Young (ayoung19) wants to merge 4 commits into
Draft
docs(langsmith): add Engine webhook events reference#4008Andy Young (ayoung19) wants to merge 4 commits into
Andy Young (ayoung19) wants to merge 4 commits into
Conversation
Document the two webhook events the LangSmith Engine emits today (issue.created, issue.trace.added), the shared envelope, payload shapes, delivery semantics, severity filtering, and security guidance. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Paarth Ahuja (paarth-a)
approved these changes
May 14, 2026
- SSRF DefaultPolicy allows both http and https; correct the page from "https only" to "both accepted, https recommended". - asynq MaxRetry is retries, not total attempts. webhookMaxRetry=3 yields up to 4 total attempts (1 initial + 3 retries). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
Mintlify preview branch generated: Site preview: https://langchain-5e9cc07a-preview-andyye-1778820730-7214c62.mintlify.app Preview links may take a few minutes to start working while the deployment finishes. Changed documentation pages (preview deep links): |
Florence Morris (fjmorris)
approved these changes
May 15, 2026
Contributor
Florence Morris (fjmorris)
left a comment
There was a problem hiding this comment.
Andy Young (@ayoung19) please review the changes I committed.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Adds a Stripe-style reference page documenting the webhook events the LangSmith Engine emits today. The Engine page already mentions webhook configuration but does not describe the wire format consumers need to handle the events, and the Issues UI is expected to link to this page from the webhook settings panel.
The page covers:
issue.created,issue.trace.added) with a full example payload for each.id,type,created,request_id,data) and thedata.object/data.traceschemas.id), andrequest_id-based batch coalescing.Authorization: Bearer …);https://is strongly recommended even though the SSRF default policy accepts bothhttpandhttps.New file lives next to the existing
langsmith/enginepage in the Observability tab and is registered insrc/docs.json.Known gaps — acknowledged but punted
Cross-checking the page against the in-repo Slack consumer (
smith-issues-agent/webhook_consumers/slack/handler.ts, PR langchain-ai/langchainplus#24520) surfaced two trace-linking details a consumer can't fully reconstruct from this page alone:trace://<run-id>Markdown link convention insidedata.object.descriptionanddata.trace.comment. The agent is prompted to embed trace references as[label](trace://<run-id>)rather than raw IDs (smith-issues-agent/smith_issues_agent/prompt.py:1234). The Slack consumer rewrites these to clickable LangSmith trace URLs.tenant_id+session_id+trace_id, the way the Slack consumer does. Comparedata.object.url, which we ship precisely so consumers don't reverse-engineer the issue URL.Both are intentionally out of scope here. Trace linking has known issues across the product and the behavior is expected to change; we want to nail that down before committing to it as a webhook wire contract. Once that lands, fold (1) into the description/comment field docs and add (2) as either a shipped
trace.urlfield or a documented URL template.Provenance
Verified against
origin/main(langchain-ai/langchainplus). Implementation PRs:issue.creatednamingissue.trace.addedRelease Note
none