Skip to content

Product documentation

Events

Tenant-facing Events API — poll lifecycle events (user.*, client.*, federation.*) forward from a cursor; the signature-free twin of tenant webhooks.

Events

Tenant-facing Events API — poll lifecycle events (user., client., federation.*) forward from a cursor; the signature-free twin of tenant webhooks.

Base URL: https://api.stg.thoryn.org

Operations

MethodPathSummaryScopes
GET/api/v1/eventsEvents Listtenant:events.read
GET/api/v1/events/{id}Events Gettenant:events.read

Operation details

GET /api/v1/events

Events List

  • Operation ID: eventsList
  • Required scopes: tenant:events.read

Parameters:

NameInRequiredTypeDescription
typequerynostring
actorIdquerynostring
organizationIdquerynostring
cursorquerynostring
limitquerynointeger

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

GET /api/v1/events/{id}

Events Get

  • Operation ID: eventsGet
  • Required scopes: tenant:events.read

Parameters:

NameInRequiredTypeDescription
idpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)