Create Prompt Webhook

Create a new prompt webhook.

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": []
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Body

application/json

Schema for creating a prompt webhook.

url · string<uri> · required

Minimum string length: 1

headers · Headers · object | null

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

id · string<uuid> | null

Response

200

application/json

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 | null

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