OpenVibe.Events API
Generated at from
openvibe-contracts v0.53.0 and
openvibe-sdk v0.11.0.
Server https://events.openvibe.network. 13 routes performing 7 capabilities. OpenAPI 3.1 document.
GET /api/v1/checkpoints
Pull events as a developer app (ADR-014): only the app's own project's events (app.<project_key>.*, same environment as the token) plus first-party platform events with visibility public.
- Capabilities
- events.app.read, events.event.read
- Visibility
- public, internal
- Input
- events.read-request@1
- Response
application/jsonevents.read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>events.app.read</strong> (public): Pull events as a developer app (ADR-014): only the app's own project's events (app.<project_key>.*, same environment as the token) plus first-party platform events with visibility public. Topic patterns must start with a literal segment; app.* patterns must name the caller's own project_key. Checkpoints are stored per app.</p> <p><strong>events.event.read</strong> (internal): Read retained events of every visibility with a seq cursor (pull consumers), keep per-consumer checkpoints, and open realtime streams as a service principal.</p>PUT /api/v1/checkpoints
Pull events as a developer app (ADR-014): only the app's own project's events (app.<project_key>.*, same environment as the token) plus first-party platform events with visibility public.
- Capabilities
- events.app.read, events.event.read
- Visibility
- public, internal
- Request body
application/jsonevents.read-request@1- Response
application/jsonevents.read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>events.app.read</strong> (public): Pull events as a developer app (ADR-014): only the app's own project's events (app.<project_key>.*, same environment as the token) plus first-party platform events with visibility public. Topic patterns must start with a literal segment; app.* patterns must name the caller's own project_key. Checkpoints are stored per app.</p> <p><strong>events.event.read</strong> (internal): Read retained events of every visibility with a seq cursor (pull consumers), keep per-consumer checkpoints, and open realtime streams as a service principal.</p>GET /api/v1/deliveries
Operator access: inspect deliveries (including the dead-letter queue) and replay events to any subscription.
- Capabilities
- events.delivery.admin
- Visibility
- internal
- Input
- events.delivery-admin-request@1
- Response
application/jsonevents.delivery-admin-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>events.delivery.admin</strong> (internal): Operator access: inspect deliveries (including the dead-letter queue) and replay events to any subscription.</p>POST /api/v1/deliveries/replay
Operator access: inspect deliveries (including the dead-letter queue) and replay events to any subscription.
- Capabilities
- events.delivery.admin
- Visibility
- internal
- Request body
application/jsonevents.delivery-admin-request@1- Response
application/jsonevents.delivery-admin-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>events.delivery.admin</strong> (internal): Operator access: inspect deliveries (including the dead-letter queue) and replay events to any subscription.</p>GET /api/v1/events
Pull events as a developer app (ADR-014): only the app's own project's events (app.<project_key>.*, same environment as the token) plus first-party platform events with visibility public.
- Capabilities
- events.app.read, events.event.read
- Visibility
- public, internal
- Input
- events.read-request@1
- Response
application/jsonevents.read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>events.app.read</strong> (public): Pull events as a developer app (ADR-014): only the app's own project's events (app.<project_key>.*, same environment as the token) plus first-party platform events with visibility public. Topic patterns must start with a literal segment; app.* patterns must name the caller's own project_key. Checkpoints are stored per app.</p> <p><strong>events.event.read</strong> (internal): Read retained events of every visibility with a seq cursor (pull consumers), keep per-consumer checkpoints, and open realtime streams as a service principal.</p>POST /api/v1/events
Publish durable events (events.event-envelope@1) as a developer app (ADR-014).
- Capabilities
- events.app.publish, events.event.publish
- Visibility
- public, internal
- Request body
application/jsonevents.publish-request@1- Response
application/jsonevents.publish-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>events.app.publish</strong> (public): Publish durable events (events.event-envelope@1) as a developer app (ADR-014). The app token (sub app:app_<ULID>, project_id prj_<ULID>, env) may publish only event types app.<project_key>.<name>[.<more>], where project_key is 'p' followed by the project's ULID in lowercase (prj_01JAB... -> p01jab...). source must be 'app-' followed by the app's ULID in lowercase; actor is the app (or the on_behalf_of user). Events stores the token's env with each event: sandbox events are never delivered to production subscriptions nor shown to production apps. Rate and retained bytes are limited per project and environment by OpenVibe.Events.</p> <p><strong>events.event.publish</strong> (internal): Publish durable events (events.event-envelope@1) as the calling service: source must be the principal's service slug and event_type must use a prefix that source owns. Idempotent on event_id.</p>GET /api/v1/events/{event_id}
Pull events as a developer app (ADR-014): only the app's own project's events (app.<project_key>.*, same environment as the token) plus first-party platform events with visibility public.
- Capabilities
- events.app.read, events.event.read
- Visibility
- public, internal
- Parameters
event_id(path, required)
- Input
- events.read-request@1
- Response
application/jsonevents.read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>events.app.read</strong> (public): Pull events as a developer app (ADR-014): only the app's own project's events (app.<project_key>.*, same environment as the token) plus first-party platform events with visibility public. Topic patterns must start with a literal segment; app.* patterns must name the caller's own project_key. Checkpoints are stored per app.</p> <p><strong>events.event.read</strong> (internal): Read retained events of every visibility with a seq cursor (pull consumers), keep per-consumer checkpoints, and open realtime streams as a service principal.</p>GET /api/v1/subscriptions
Manage webhook subscriptions as a developer app (ADR-014).
- Capabilities
- events.app.subscribe, events.subscription.manage
- Visibility
- public, internal
- Input
- events.subscription-request@1
- Response
application/jsonevents.subscription-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>events.app.subscribe</strong> (public): Manage webhook subscriptions as a developer app (ADR-014). Topic patterns are limited to the scope of events.app.read (own project's app.<project_key>.* events in the token's environment, plus public platform events). Endpoints must be https URLs whose host resolves only to public IP addresses; OpenVibe.Events re-checks the resolved address when it delivers and never follows redirects. Deliveries are signed with the subscription secret (X-OpenVibe-Signature: sha256=<HMAC of the raw body>). Subscriptions carry project_id and env; sandbox events reach sandbox subscriptions only.</p> <p><strong>events.subscription.manage</strong> (internal): Create, list, disable and enable the calling service's own webhook subscriptions (topic pattern + allow-listed internal endpoint, HMAC-signed deliveries with retry and dead letters).</p>POST /api/v1/subscriptions
Manage webhook subscriptions as a developer app (ADR-014).
- Capabilities
- events.app.subscribe, events.subscription.manage
- Visibility
- public, internal
- Request body
application/jsonevents.subscription-request@1- Response
application/jsonevents.subscription-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>events.app.subscribe</strong> (public): Manage webhook subscriptions as a developer app (ADR-014). Topic patterns are limited to the scope of events.app.read (own project's app.<project_key>.* events in the token's environment, plus public platform events). Endpoints must be https URLs whose host resolves only to public IP addresses; OpenVibe.Events re-checks the resolved address when it delivers and never follows redirects. Deliveries are signed with the subscription secret (X-OpenVibe-Signature: sha256=<HMAC of the raw body>). Subscriptions carry project_id and env; sandbox events reach sandbox subscriptions only.</p> <p><strong>events.subscription.manage</strong> (internal): Create, list, disable and enable the calling service's own webhook subscriptions (topic pattern + allow-listed internal endpoint, HMAC-signed deliveries with retry and dead letters).</p>GET /api/v1/subscriptions/{id}
Manage webhook subscriptions as a developer app (ADR-014).
- Capabilities
- events.app.subscribe, events.subscription.manage
- Visibility
- public, internal
- Parameters
id(path, required)
- Input
- events.subscription-request@1
- Response
application/jsonevents.subscription-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>events.app.subscribe</strong> (public): Manage webhook subscriptions as a developer app (ADR-014). Topic patterns are limited to the scope of events.app.read (own project's app.<project_key>.* events in the token's environment, plus public platform events). Endpoints must be https URLs whose host resolves only to public IP addresses; OpenVibe.Events re-checks the resolved address when it delivers and never follows redirects. Deliveries are signed with the subscription secret (X-OpenVibe-Signature: sha256=<HMAC of the raw body>). Subscriptions carry project_id and env; sandbox events reach sandbox subscriptions only.</p> <p><strong>events.subscription.manage</strong> (internal): Create, list, disable and enable the calling service's own webhook subscriptions (topic pattern + allow-listed internal endpoint, HMAC-signed deliveries with retry and dead letters).</p>POST /api/v1/subscriptions/{id}/disable
Manage webhook subscriptions as a developer app (ADR-014).
- Capabilities
- events.app.subscribe, events.subscription.manage
- Visibility
- public, internal
- Parameters
id(path, required)
- Request body
application/jsonevents.subscription-request@1- Response
application/jsonevents.subscription-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>events.app.subscribe</strong> (public): Manage webhook subscriptions as a developer app (ADR-014). Topic patterns are limited to the scope of events.app.read (own project's app.<project_key>.* events in the token's environment, plus public platform events). Endpoints must be https URLs whose host resolves only to public IP addresses; OpenVibe.Events re-checks the resolved address when it delivers and never follows redirects. Deliveries are signed with the subscription secret (X-OpenVibe-Signature: sha256=<HMAC of the raw body>). Subscriptions carry project_id and env; sandbox events reach sandbox subscriptions only.</p> <p><strong>events.subscription.manage</strong> (internal): Create, list, disable and enable the calling service's own webhook subscriptions (topic pattern + allow-listed internal endpoint, HMAC-signed deliveries with retry and dead letters).</p>POST /api/v1/subscriptions/{id}/enable
Manage webhook subscriptions as a developer app (ADR-014).
- Capabilities
- events.app.subscribe, events.subscription.manage
- Visibility
- public, internal
- Parameters
id(path, required)
- Request body
application/jsonevents.subscription-request@1- Response
application/jsonevents.subscription-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>events.app.subscribe</strong> (public): Manage webhook subscriptions as a developer app (ADR-014). Topic patterns are limited to the scope of events.app.read (own project's app.<project_key>.* events in the token's environment, plus public platform events). Endpoints must be https URLs whose host resolves only to public IP addresses; OpenVibe.Events re-checks the resolved address when it delivers and never follows redirects. Deliveries are signed with the subscription secret (X-OpenVibe-Signature: sha256=<HMAC of the raw body>). Subscriptions carry project_id and env; sandbox events reach sandbox subscriptions only.</p> <p><strong>events.subscription.manage</strong> (internal): Create, list, disable and enable the calling service's own webhook subscriptions (topic pattern + allow-listed internal endpoint, HMAC-signed deliveries with retry and dead letters).</p>GET /realtime/stream
Read retained events of every visibility with a seq cursor (pull consumers), keep per-consumer checkpoints, and open realtime streams as a service principal.
- Capabilities
- events.event.read
- Visibility
- internal
- Input
- events.read-request@1
- Response
application/jsonevents.read-result@1- Errors
- errors.problem@1 (application/problem+json)