ConnectHookReceivedPayload connect.hook.received@1

Generated at 2026-11-13 06:25:48 UTC from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

Version

1.0.0

Owner

connect

Visibility

first-party

Status

active

Compatibility

backward

Schema

https://openvibe.network/contracts/events/payloads/connect.hook.received.v1.json

connect.hook.received v1 (OpenVibe Connect, CON-15, ADR-057 decision 7): a webhook reached a share's hook at https://connect.openvibe.website/h/<hook_id>. Connect keeps the request's body and headers by reference (hook_bodies, 7 days) and publishes only this pointer; Events keeps the event and retries Connect's own subscription for up to seven days, so the request reaches the person's computer when it is back. No body, header or address is in the event. Envelope: subject { type: connect.hook, id: <hook_id> }, visibility internal, priority important, actor service:connect.

Fields

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

{
  "hook_id": "hk_01K9ZZZZZZZZZZZZZZZZZZZZZZ",
  "share_id": "shr_01K9ZZZZZZZZZZZZZZZZZZZZZZ",
  "body_ref": "hb_Q2xhc3NpY0hvb2tCb2R5UmVm",
  "method": "POST",
  "size": 7421,
  "content_type": "application/json",
  "received_at": "2026-11-03T01:00:00.000Z"
}

{
  "hook_id": "hk_01K9ZZZZZZZZZZZZZZZZZZZZZZ",
  "share_id": "shr_01K9ZZZZZZZZZZZZZZZZZZZZZZ",
  "body_ref": "hb_Q2xhc3NpY0hvb2tCb2R5UmVm",
  "method": "POST",
  "size": 12,
  "received_at": "2026-11-03T01:00:00.000Z",
  "body": "{\"secret\":1}"
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('connect.hook.received@1', value);   // { valid, errors: [{ path, message }] }