LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Client
  • AsyncClient
  • Run Helpers
  • Run Trees
  • Evaluation
  • Schemas
  • Utilities
  • Wrappers
  • Anonymizer
  • Testing
  • Expect API
  • Middleware
  • Pytest Plugin
  • Deployment SDK
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

OverviewClientAsyncClientRun HelpersRun TreesEvaluationSchemasUtilitiesWrappersAnonymizerTestingExpect APIMiddlewarePytest PluginDeployment SDK
Language
Theme
Pythonlangsmithtypesprompt_webhook_test_paramsWebhook
Class●Since v0.14

Webhook

Copy
Webhook()

Bases

TypedDict

Constructors

Attributes

View source on GitHub
constructor
__init__
NameType
urlRequired[str]
exclude_promptsOptional[SequenceNotStr[str]]
headersOptional[Dict[str, object]]
include_promptsOptional[SequenceNotStr[str]]
triggersList[Literal['commit', 'tag:create', 'tag:update']]
attribute
url: Required[str]

URL that receives a POST request with the prompt event payload.

attribute
exclude_prompts: Optional[SequenceNotStr[str]]

IDs of prompts whose events never fire the webhook.

attribute
headers: Optional[Dict[str, object]]

HTTP headers sent with each request, for example an Authorization header.

Values are stored encrypted and are masked in responses to callers who cannot update prompts.

attribute
include_prompts: Optional[SequenceNotStr[str]]

IDs of the prompts whose events fire the webhook.

When empty, events from every prompt in the workspace fire it.

attribute
triggers: List[Literal['commit', 'tag:create', 'tag:update']]

Events that fire the webhook: commit (a new prompt commit), tag:create, and tag:update. A webhook with no triggers never fires.

Base schema for prompt webhooks.