Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <key>. A key is nrk_live_ or nrk_test_, a 26-character key id, _ and a 43-character secret. A key sees only its own environment's data.

Each key has one or more scopes: assess creates and reads assessments, records outcomes and reports key usage; history reads assessments, an account's current risk and an account's history, and erases an account; detailed adds the detailed view; webhooks registers, tests, rotates and deletes webhook endpoints; integrations registers and manages hosted provider integrations. A missing, unknown, revoked or expired key answers 401. A valid key without the scope an operation needs answers 403.

Path Parameters

endpoint_id
string
required

The endpoint's whe_ id. An id that is unknown, malformed or another workspace's answers 404. Opaque id of the endpoint registration.

Pattern: ^whe_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json

POST /v1/webhooks/{endpoint_id}/test body: which event to send.

event
enum<string>
required

endpoint.verification sends a fresh challenge now, in this call, and the endpoint is verified if it echoes it. assessment.updated queues an event whose data is a fixed example assessment, with test true, delivered and retried like any other; the endpoint must be verified.

Available options:
endpoint.verification,
assessment.updated

Response

The test event: sent, for endpoint.verification, or queued for delivery, for assessment.updated.

The 202 answer of POST /v1/webhooks/{endpoint_id}/test: the event that was sent or queued.

delivery_id
string
required

The event id the receiver sees as NR-Webhook-Id and as the body's id.

Pattern: ^evt_[0-9A-HJKMNP-TV-Z]{26}$
endpoint_id
string
required

Opaque id of the endpoint registration.

Pattern: ^whe_[0-9A-HJKMNP-TV-Z]{26}$
event
enum<string>
required
Available options:
endpoint.verification,
assessment.updated
state
enum<string>
required

The endpoint's state after this call.

Available options:
unverified,
verified,
disabled
verified
boolean

endpoint.verification only: true when the endpoint echoed the challenge within 5 seconds. A false answer leaves the endpoint's state as it was.