Skip to content
API Reference
/
EventService
/
Retrieve an event

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://docs.bndry.net/_mock/apis/openapi/

https://api.bndry.app/

Documents

Service for managing documents.

Operations

Form Definitions

Service for managing form definitions.

Operations

Forms

Operations

Workspaces

Service for managing workspaces and their associated forms and documents.

Operations

Automations

Service for managing and executing automations.

Operations

EventService

EventService provides operations for managing events

Operations

Retrieve an event

Request

Get retrieves a single event by its resource name

Security
oauth2_client_credentials or oauth2_authorization_code
Path
eventstringrequired

The event id.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/events/{event}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
namestring(name)non-empty

(IDENTIFIER) The resource name of the event Format: "events/{event}" or "entities/{entity}/events/{event}"

eventTypestring(event_type)non-emptyrequired

The type of event

eventPayloadstring(byte)(event_payload)

(OPTIONAL) The event payload as raw bytes

createTimestring(date-time)(google.protobuf.Timestamp)read-onlyrequired

The time when the event was created

creatorstring(creator)non-emptyrequired

The user ID who created the event

Response
application/json
{
  "name": "string",
  "eventType": "string",
  "eventPayload": "string",
  "createTime": "1s",
  "creator": "string"
}

Retrieve an event

Request

Get retrieves a single event by its resource name

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

eventstringrequired

The event id.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}/events/{event}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
namestring(name)non-empty

(IDENTIFIER) The resource name of the event Format: "events/{event}" or "entities/{entity}/events/{event}"

eventTypestring(event_type)non-emptyrequired

The type of event

eventPayloadstring(byte)(event_payload)

(OPTIONAL) The event payload as raw bytes

createTimestring(date-time)(google.protobuf.Timestamp)read-onlyrequired

The time when the event was created

creatorstring(creator)non-emptyrequired

The user ID who created the event

Response
application/json
{
  "name": "string",
  "eventType": "string",
  "eventPayload": "string",
  "createTime": "1s",
  "creator": "string"
}

List events

Request

List retrieves multiple events with pagination

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

Query
pageSizeinteger(int32)(page_size)

The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 10 events will be returned. The maximum value is 100; values above 100 will be coerced to 100.

pageTokenstring(page_token)

A page token, received from a previous ListEvents call. Provide this to retrieve the subsequent page.

skipinteger(int32)(skip)

Optional. The number of resources to skip over before returning resources. Default is 0. See: https://google.aip.dev/158#skipping-results

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}/events?pageSize=0&pageToken=string&skip=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
eventsArray of objects(events)

The list of events

nextPageTokenstring(next_page_token)

A token to retrieve the next page of results. If this field is omitted, there are no subsequent pages.

totalSizeinteger(int32)(total_size)

The total number of events (may be an estimate)

Response
application/json
{
  "events": [
    { … }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}

Notes

Operations

Tenants

Service for managing tenants.

Operations

Entities

Operations

Onboard Individual (Verify Identity)

Service for managing individual entity onboarding jobs.

Operations

Truuth

TruuthService provides an API for the BNDRY SPA to initiate a new verification session with Truuth

Operations