prompt-webhooks

Update Prompt Webhook

Changed on

Update a specific prompt webhook.

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

patch/api/v1/prompt-webhooks/{webhook_id}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/prompt-webhooks/{webhook_id}
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Path parameters

webhook_idstring uuid required

Request body

include_promptsstring[] nullable

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

exclude_promptsstring[] nullable

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

urlstring uri nullable

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

headersobject nullable

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

triggersEPromptWebhookTrigger[] nullable

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

Response

Successful Response

urlstring uri required

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

headersobject nullable

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_promptsstring[] nullable

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

exclude_promptsstring[] nullable

IDs of prompts whose events never fire the webhook.

triggersEPromptWebhookTrigger[]

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

idstring uuid required
tenant_idstring uuid required
created_atstring date-time required
updated_atstring date-time required

Changes

  • 1a8ee9358d81Revision changes
    • breaking

      the / response's property type changed from object to string for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status