Skip to content

Run a metadata-only SIEM/webhook delivery check.

POST
/v1/siem-webhooks/{destination_id}/test
destination_id
required
string
>= 1 characters
object
tenant_id
required
string
>= 1 characters
environment_id
required
string
>= 1 characters
reason_code
required
string
/^[a-z0-9_]+$/

Test accepted and audited; response contains delivery metadata only.

object
schemaVersion
required
request_id
required
string
>= 1 characters
tenant_id
required
string
>= 1 characters
environment_id
required
string
>= 1 characters
destination_id
required
string
>= 1 characters
accepted
required
boolean
delivery_status
required
object
status
required
Allowed values: healthy degraded failed disabled unknown
checked_at
required
string format: date-time
reason_code
required
string
/^[a-z0-9_]+$/
last_error
object
reason_code
required
string
/^[a-z0-9_]+$/
retryable
boolean
audit_event_ref
required
string
>= 1 characters
permissions
required
object
allowed_actions
required
Array
Allowed values: read create update test disable

Caller lacks permission to test this destination.

object
schemaVersion
required
requestId
required
string
>= 1 characters
status
required
integer
>= 400 <= 599
reasonCode
required
string
/^[a-z0-9_]+$/
message
required
string
>= 1 characters
retryable
required
boolean
machineSafe
required
boolean
redactionStatus
required
Allowed values: redacted metadata_only
field

Optional metadata-only field identifier for validation errors.

string
details

Optional metadata-only diagnostic details. Never include secret material, payloads, prompts, raw endpoint URLs, or customer data.

object
requiredAction
string
>= 1 characters
resourceRef
string
>= 1 characters
key
additional properties
One of:
string

Destination not found in tenant/environment scope.

object
schemaVersion
required
requestId
required
string
>= 1 characters
status
required
integer
>= 400 <= 599
reasonCode
required
string
/^[a-z0-9_]+$/
message
required
string
>= 1 characters
retryable
required
boolean
machineSafe
required
boolean
redactionStatus
required
Allowed values: redacted metadata_only
field

Optional metadata-only field identifier for validation errors.

string
details

Optional metadata-only diagnostic details. Never include secret material, payloads, prompts, raw endpoint URLs, or customer data.

object
requiredAction
string
>= 1 characters
resourceRef
string
>= 1 characters
key
additional properties
One of:
string

Type set in Geist, Source Serif 4, and Departure Mono.