Create a test sink

Creates a deterministic receiver for one callback endpoint so failures can be rehearsed before they happen in production. Test environments only: a live principal has no such operation, and there is no request field that could widen the organization, project, or environment the sink belongs to. The sink verifies deliveries with the bound endpoint's own signing keys, so key rotation and a wrong key behave here exactly as they would at the customer's receiver. It receives and never sends: no field names a destination and no configuration makes it forward a delivery. Point the endpoint at the returned url, and every attempt lands here.

post/v1/test-sinks

Request

  • Base URL: https://docs.greatwait.dev (the document declares no server; this is the origin it was published from)
  • URL: https://docs.greatwait.dev/v1/test-sinks
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header Greatwait-Environment and API key in header Greatwait-Project

Request body

endpointstring required

Response

Create a test sink

createdAtstring required
deliveryCountinteger required
endpointstring required
environmentKind'test' required
idstring required
projectstring required
updatedAtstring required
urlstring uri required

Changes

No recorded changes to this operation across all 1 revision of this API.