Event Access

Create Event Access

post/v1/event-access

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/event-access
  • Auth: one of:
    • Session (a scheme the document does not define)
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: user:secrets:write)

Request body

activeboolean required
clientIdstring
clientSecretstring
connectionDefinitionIdstring required

Prefixed ID with 'conn_def' prefix (e.g., 'conn_def_1C'), also accepts raw integer

environment'test' | 'live' required
guidestring nullable
scopesstring nullable
useDefaultOauthCredsboolean nullable

When true, uses default OAuth credentials from the engineering account instead of user-provided credentials. See the struct-level documentation for detailed precedence behavior and requirements.

Response

Created event access key

accessKeystring required
activeboolean required
changeLogChangeLog required
connectionType'api' | 'databasesql' | 'databasenosql' | 'filesystem' | 'stream' | 'custom' required
createdAtstring date-time required
defaultboolean required
deletedboolean required
environment'test' | 'live' required
idstring required

Prefixed ID with 'evt_ac' prefix (e.g., 'evt_ac_1C'), also accepts raw integer

keystring required
keyPreviewstring nullable
namestring nullable
organizationIdstring uuid nullable
tagsstring[] required
throughputinteger nullable
updatedAtstring date-time required
userIdstring uuid required
versionstring required

Changes

No recorded changes to this operation across all 1 revision of this API.