Skip to main content
POST
Test Alert Webhook
Applies to BloodHound Enterprise Only

Authorizations

Authorization
string
header
required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer
string
default:wait=30

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. Passing in wait=-1 bypasses all timeout limits when the feature is enabled.

Pattern: ^wait=(-1|[0-9]+)$

Path Parameters

alert_webhook_id
string<uuid>
required

ID of an alert webhook. uuidv4

Body

application/json

Request body for dispatching a mock payload to an alert webhook.

event_type
string
required

The alert event type to mock in the dispatched payload. The server builds a representative payload for the given type using the webhook's current HMAC secret.

version
integer
required

Payload data version for the supplied event_type. Must be one of the data versions advertised for that type by GET /api/v2/alert-event-types.

Response

OK

data
object

Result of dispatching a mock payload to an alert webhook. The handler returns this body with a 200 status code on both successful and failed upstream deliveries; the status_code and error fields surface the upstream outcome.