Test prompt webhook

Test a specific prompt webhook.

Sends the sample payload to the webhook configuration in the request body without saving it, but only if the webhook’s triggers include the payload’s event and its prompt filters match the payload’s prompt. Otherwise nothing is sent. Fails if the destination does not accept the payload.

POST /api/v1/prompt-webhooks/test

Error

A valid request URL is required to generate request examples

200

{}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Body

application/json

Schema for testing a prompt webhook.

webhook · PromptWebhookBase · object · required

Base schema for prompt webhooks.

Show child attributes

payload · PromptWebhookPayload · object · required

Show child attributes

Response

200

application/json

Successful Response

{key} · string