Skip to main content
POST
Test an endpoint

Authorizations

Authorization
string
header
required

A workspace API key with the outbound_webhooks:write scope, sent as Authorization: Bearer <key>.

Path Parameters

endpoint_id
string
required

The endpoint's ID.

Example:

"6ac2a82edfafd1b6c6a9c27d"

Response

Successful Response

The endpoint and the result of its activation test.

activated
boolean
required

Whether the endpoint passed the test and is active.

endpoint
EndpointResponse · object
required
Example:
detail
string
default:""

A sentence explaining the result. Not a stable contract.

failure_category
string | null

Why the test failed: timeout, transport (no connection), server_error (5xx), client_error (4xx, or a 2xx without the challenge), redirect, ssrf_rejected (the URL resolved to a non-public address) or internal. Null on success.

http_status
integer | null

The status your endpoint answered with. Null when it didn't answer.