Create a callback endpoint

Creates a reusable callback endpoint in the caller's project and environment. The destination must be HTTPS on effective port 443, contain no URL credentials or fragment, and resolve only to public unicast addresses. The endpoint is active and usable the moment it exists; there is nothing to verify. A disabled endpoint is never delivered to, and a schedule write naming one answers not_found, because disabling is terminal rather than a state to recover from. The per-endpoint secret is returned to this call and to no other call an API credential or an OAuth token can make; a signed-in member can read it again through endpoints.revealSigningSecret. There is no endpoint-count ceiling. Disabled endpoints remain readable for audit; request and DNS inspection admission bound creation work and reads are paged. Optional headers set reusable defaults. Ordinary values remain readable; secret: true encrypts a write-only value that is never returned. Header edits use explicit set, keep, and remove actions.

post/v1/endpoints

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/endpoints
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header Greatwait-Environment and API key in header Greatwait-Project

Request body

namestring
urlstring uri required

Response

Create a callback endpoint

createdAtstring required
disabledAtstring
environmentKind'test' | 'live' required
idstring required
namestring
projectstring required
status'active' | 'disabled' required
updatedAtstring required
urlstring uri required
versioninteger required
keyIdstring required
secretstring required
shownOncetrue required

Changes

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