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
Pythonlangsmithresourcesprompt_webhooksPromptWebhooksResourceupdate
Method●Since v0.14

update

Copy
update(
  self,
  webhook_id: str,
  *,
  exclude_prompts: Optional[SequenceNotStr[
View source on GitHub
str
]
]
|
Omit
=
omit
,
headers
:
Optional
[
Dict
[
str
,
object
]
]
|
Omit
=
omit
,
include_prompts
:
Optional
[
SequenceNotStr
[
str
]
]
|
Omit
=
omit
,
triggers
:
Optional
[
List
[
Literal
[
'commit'
,
'tag:create'
,
'tag:update'
]
]
]
|
Omit
=
omit
,
url
:
Optional
[
str
]
|
Omit
=
omit
,
extra_headers
:
Headers
|
None
=
None
,
extra_query
:
Query
|
None
=
None
,
extra_body
:
Body
|
None
=
None
,
timeout
:
float
|
httpx
.
Timeout
|
None
|
NotGiven
=
not_given
)
->
PromptWebhook

Parameters

NameTypeDescription
exclude_promptsOptional[SequenceNotStr[str]] | Omit
Default:omit

IDs of prompts whose events never fire the webhook, replacing the current list. Omit to keep it.

headersOptional[Dict[str, object]] | Omit
Default:omit
include_promptsOptional[SequenceNotStr[str]] | Omit
Default:omit
triggersOptional[List[Literal['commit', 'tag:create', 'tag:update']]] | Omit
Default:omit
urlOptional[str] | Omit
Default:omit
extra_headersHeaders | None
Default:None
extra_queryQuery | None
Default:None
extra_bodyBody | None
Default:None
timeoutfloat | httpx.Timeout | None | NotGiven
Default:not_given

Update a specific prompt webhook.

Omitted fields keep their current values; list fields and headers that are set replace the stored values.

HTTP headers sent with each request, replacing all current headers. Omit to keep them. Masked values (****) from a read are rejected.

IDs of the prompts whose events fire the webhook, replacing the current list. Omit to keep it.

Events that fire the webhook (commit, tag:create, tag:update), replacing the current list. Omit to keep it.

URL that receives the POST requests. Omit to keep the current URL.

Send extra headers

Add additional query parameters to the request

Add additional JSON properties to the request

Override the client-level default timeout for this request, in seconds