live · mainnetoc · docs
specs · api · guides
docs / documentation

@orangecheck/me-client


@orangecheck/me-client / WebhookHeaders

Interface: WebhookHeaders

Defined in: me-client/src/types.ts:277

HTTP headers OC sends with every webhook delivery. Capture these in the receive handler · OC-Signature is what verifies the body.

Properties

PropertyTypeDescriptionDefined in
<a id="property-oc-class"></a> OC-ClassEventClassClass · matches payload.class.me-client/src/types.ts:291
<a id="property-oc-delivery-attempt"></a> OC-Delivery-Attemptstring1-indexed delivery attempt count. >1 means the prior attempt did not return a 2xx within the timeout · idempotency key on payload.id is critical.me-client/src/types.ts:295
<a id="property-oc-envelope-id"></a> OC-Envelope-IdstringEnvelope id · matches payload.id; useful for idempotent receive handlers that dedupe on this header without parsing the body.me-client/src/types.ts:286
<a id="property-oc-key-id"></a> OC-Key-IdstringStable kid of the signing key · resolves against ochk.io/.well-known/jwks.json.me-client/src/types.ts:282
<a id="property-oc-signature"></a> OC-SignaturestringEd25519 signature over the raw response body, hex-encoded.me-client/src/types.ts:279
<a id="property-oc-subtype"></a> OC-SubtypeEventSubtypeSubtype · matches payload.subtype; lets routers branch on the header before parsing.me-client/src/types.ts:289