Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

API Key authentication for programmatic access. Include your API key in the Authorization header as: Bearer your_api_key_here

Path Parameters

destinationId
string<uuid>
required

Body

application/json
outputType
enum<string>
required

The context the destination is configured in; determines the example payload shape and formatting

Available options:
detection,
response,
acceptance-criteria,
threat-intel,
threat,
hunt-alert,
alert-escalation
payload
required

The (possibly user-edited) example payload to send. For webhook it is the full envelope (POSTed verbatim); for the response context on non-webhook destinations it is just the structured output.

structuredOutputSchema
object | null

For the response context: the agent structured-output schema, so the test send formats the payload the same way the real delivery path does

agentName
string

For the response context on non-webhook destinations: the agent name shown in the message header

Response

Successful response

success
boolean
required

Whether the test output was delivered

destinationType
enum<string>
required

Type of destination the test was sent to

Available options:
webhook,
teams,
slack,
pagerduty,
linear,
tines
detail
string

Optional human-readable detail about the delivery (e.g. created issue identifier)

outputUrl
string<uri>

Direct URL to the created output when the destination provides one

Human-readable label for the created output link