Connections API — eyeball docs

Create and administer user-scoped development connection records.

`ConnectionsClient`

User-scoped development connections exposed by the executor fixture API.

`create`

Creates a connected development fixture for one user and toolkit.

Hosted OAuth authorization remains an eyeball Cloud boundary.

create(options: CreateConnectionOptions): Promise<ConnectedConnection>

Parameter	Type	Required	Description
`options`	`CreateConnectionOptions`	Yes	Toolkit slug and optional user override.

Returns: Promise<ConnectedConnection>

Throws

EyeballError with not_supported when the executor has no connection route, or another normalized request error.

`delete`

Revokes a development connection fixture.

delete(connectionId: `conn_${string}`): Promise<RevokedConnection>

Parameter	Type	Required	Description
`connectionId`	`conn_${string}`	Yes	Project-scoped connection identifier.

Returns: Promise<RevokedConnection>

Throws

EyeballError when the connection is unavailable or the request fails.

`list`

Lists development connections visible to the authenticated project.

list(): Promise<ConnectionPage>

This call has no parameters.

Returns: Promise<ConnectionPage>

Throws

EyeballError when the executor request fails.

Types

`CreateConnectionOptions`

User and toolkit fields for a development connection fixture.

export interface CreateConnectionOptions {
  /** Uses the client-level userId when omitted. */
  userId?: string;
  toolkit: string;
}

Property	Type	Required	Readonly	Description
`toolkit`	`string`	Yes	No	—
`userId`	`string`	No	No	Uses the client-level userId when omitted.

`ConnectedConnection`

Successful development connection creation result.

export interface ConnectedConnection {
  connectionId: ConnectionId;
  redirectUrl: null;
  status: "connected";
}

Property	Type	Required	Readonly	Description
`connectionId`	`conn_${string}`	Yes	No	—
`redirectUrl`	`null`	Yes	No	—
`status`	`"connected"`	Yes	No	—

`ConnectionSummary`

Public connection status returned by the development executor API.

export interface ConnectionSummary {
  connectionId: ConnectionId;
  createdAt: string;
  userId: string;
  toolkit: string;
  status: "connected" | "expired" | "revoked";
}

Property	Type	Required	Readonly	Description
`connectionId`	`conn_${string}`	Yes	No	—
`createdAt`	`string`	Yes	No	—
`status`	`"connected" \| "expired" \| "revoked"`	Yes	No	—
`toolkit`	`string`	Yes	No	—
`userId`	`string`	Yes	No	—

`ConnectionPage`

Collection of development connection summaries.

export interface ConnectionPage {
  connections: readonly ConnectionSummary[];
}

Property	Type	Required	Readonly	Description
`connections`	`readonly ConnectionSummary[]`	Yes	No	—

`RevokedConnection`

Result returned after a development connection is revoked.

export interface RevokedConnection {
  connectionId: ConnectionId;
  status: "revoked";
}

Property	Type	Required	Readonly	Description
`connectionId`	`conn_${string}`	Yes	No	—
`status`	`"revoked"`	Yes	No	—

`ConnectionId`

export type ConnectionId = `conn_${string}`;