| Name | Type | Description |
|---|---|---|
url* | str | URL that receives a POST request with the prompt event payload. |
id | Optional[str] | Omit | Default: omitID to assign to the webhook. Generated when omitted. |
exclude_prompts | Optional[SequenceNotStr[str]] | Omit | Default: omit |
headers | Optional[Dict[str, object]] | Omit | Default: omit |
include_prompts | Optional[SequenceNotStr[str]] | Omit | Default: omit |
triggers | List[Literal['commit', 'tag:create', 'tag:update']] | Omit | Default: omit |
extra_headers | Headers | None | Default: None |
extra_query | Query | None | Default: None |
extra_body | Body | None | Default: None |
timeout | float | httpx.Timeout | None | NotGiven | Default: not_given |
Create a new prompt webhook.
LangSmith sends a POST request to the webhook URL for each event listed in triggers on the prompts it matches. A workspace can have one prompt webhook unless its limit was raised; creating one past the limit returns 400.
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.
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
