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_webhookPromptWebhook
Class●Since v0.14

PromptWebhook

Copy
PromptWebhook()

Bases

BaseModel

Attributes

Inherited fromBaseModel

Attributes

Amodel_fields_set: set[str]Amodel_configAmodel_construct: construct

Methods

Mto_dict
—

Recursively generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

View source on GitHub
Mto_json
—

Return the report as a JSON-serializable dict (raw JSON shape).

Mconstruct
Mmodel_dump
—

Dump the feedback, including its address.

Mmodel_dump_json
—

Usage docs: https://docs.pydantic.dev/2.4/concepts/serialization/#modelmodel_dump_json

Classes

CConfig
attribute
id: str
attribute
created_at: datetime
attribute
tenant_id: str
attribute
updated_at: datetime
attribute
url: str
attribute
exclude_prompts: Optional[List[str]]
attribute
headers: Optional[Dict[str, object]]
attribute
include_prompts: Optional[List[str]]
attribute
triggers: Optional[List[Literal['commit', 'tag:create', 'tag:update']]]

Schema for a prompt webhook.

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

IDs of prompts whose events never fire the webhook.

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.

IDs of the prompts whose events fire the webhook.

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

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