Skip to main content
PATCH
/
api
/
v1
/
prompt-webhooks
/
{webhook_id}
Error
A valid request URL is required to generate request examples
{
  "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": []
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
webhook_id
string<uuid>
required

Body

application/json

Schema for updating a prompt webhook.

​
include_prompts
string<uuid>[] | null
​
exclude_prompts
string<uuid>[] | null
​
url
string<uri> | null
Minimum string length: 1
​
headers
Headers · object
​
triggers
enum<string>[] | null

Valid trigger types for prompt webhooks.

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

Response

Successful Response

Schema for a prompt webhook.

​
url
string<uri>
required
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
​
include_prompts
string<uuid>[] | null
​
exclude_prompts
string<uuid>[] | null
​
triggers
enum<string>[]

Valid trigger types for prompt webhooks.

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