Skip to content
Relay Port

API reference

Events

The public event log, the same events the webhooks deliver.

GET/event-types

List the event types

Every public event type with its module, description and the module's stage; subscribe a webhook endpoint to a type, a prefix ending in .* or *.

Request
curl https://api.relayport.dev/event-types \
  -H "Authorization: Bearer $RELAYPORT_API_KEY"

Parameters

  • X-Api-Versionstringheader

    The API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.

    One of 2026-12-01

  • X-Workspace-Idstring (uuid)header

    The workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.

Responses

200OK
  • dataPublicEventType[]required

  • typestringrequired

  • modulestringrequired

  • descriptionstringrequired

  • stagestringrequired

    One of ga beta planned

400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable

GET/events

List public events

  • Scope webhooks:read

Newest first, in the credential's mode and brands. type takes an event type, a prefix ending in .* or *. Each event's data has the payload shape of its type in the event catalog.

Request
curl https://api.relayport.dev/events \
  -H "Authorization: Bearer $RELAYPORT_API_KEY"

Parameters

  • X-Api-Versionstringheader

    The API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.

    One of 2026-12-01

  • X-Workspace-Idstring (uuid)header

    The workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.

  • limitintegerquery

  • cursorstringquery

  • typestringquery

  • brandIdstring (uuid)query

  • fromstring (date-time)query

  • tostring (date-time)query

Responses

200OK
  • dataPublicEvent[]required

  • idstring (uuid)required

  • typestringrequired

  • timestampstring (date-time)required

  • brandIdstring (uuid) | nullrequired

  • accountIdstring (uuid) | nullrequired

  • livemodebooleanrequired

  • datamap of anyrequired

    The payload of the event type; see the event catalog

  • metaPageMetarequired

  • next_cursorstring | nullrequired

  • per_pageintegerrequired

400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable

GET/events/{id}

Get a public event

  • Scope webhooks:read
Request
curl https://api.relayport.dev/events/{id} \
  -H "Authorization: Bearer $RELAYPORT_API_KEY"

Parameters

  • X-Api-Versionstringheader

    The API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.

    One of 2026-12-01

  • X-Workspace-Idstring (uuid)header

    The workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.

  • idstring (uuid)pathrequired

Responses

200OK
  • dataPublicEventrequired

  • idstring (uuid)required

  • typestringrequired

  • timestampstring (date-time)required

  • brandIdstring (uuid) | nullrequired

  • accountIdstring (uuid) | nullrequired

  • livemodebooleanrequired

  • datamap of anyrequired

    The payload of the event type; see the event catalog

400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable