Create prompt webhook

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.

POST /api/v1/prompt-webhooks

Error

A valid request URL is required to generate request examples

200

{
  "url": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "headers": {},
  "include_prompts": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "exclude_prompts": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "triggers": [
    "commit"
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Body

application/json

Schema for creating a prompt webhook.

url · string<uri> · required

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

Minimum string length: 1

headers · Headers · object | null

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.

include_prompts · string<uuid>[] | null

IDs of the prompts whose events fire the webhook. When empty, events from every prompt in the workspace fire it.

exclude_prompts · string<uuid>[] | null

IDs of prompts whose events never fire the webhook.

triggers · enum<string>[]

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

Valid trigger types for prompt webhooks.

Available options: commit, tag:create, tag:update

id · string<uuid> | null

ID to assign to the webhook. Generated when omitted.

Response

200

application/json

Successful Response

Schema for a prompt webhook.

url · string<uri> · required

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

Minimum string length: 1

id · string<uuid> · required

tenant_id · string<uuid> · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

headers · Headers · object | null

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.

include_prompts · string<uuid>[] | null

IDs of the prompts whose events fire the webhook. When empty, events from every prompt in the workspace fire it.

exclude_prompts · string<uuid>[] | null

IDs of prompts whose events never fire the webhook.

triggers · enum<string>[]

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

Valid trigger types for prompt webhooks.

Available options: commit, tag:create, tag:update