Integration API Reference

Complete API reference for the Integration resource in the beeps SDK.

Integration Methods

client.integration.create(input)

Create a new integration.

Parameters:

• input: CreateIntegrationInput

Returns: Promise<Integration>

Example:

const integration = await client.integration.create({
  name: "Devin Production",
  provider: "devin",
  apiKey: process.env.DEVIN_API_KEY,
  metadata: {
    environment: "production",
  },
});

client.integration.list()

List all integrations in your organization.

Returns: Promise<Integration[]>

Example:

const integrations = await client.integration.list();

client.integration.get(integrationId)

Get a specific integration by ID.

Parameters:

• integrationId: string

Returns: Promise<Integration>

Example:

const integration = await client.integration.get("int_abc123");

client.integration.update(integrationId, input)

Update an integration.

Parameters:

• integrationId: string
• input: UpdateIntegrationInput

Returns: Promise<Integration>

Example:

const updated = await client.integration.update("int_abc123", {
  name: "Updated Name",
  apiKey: process.env.NEW_API_KEY,
});

client.integration.delete(integrationId)

Delete an integration.

Parameters:

• integrationId: string

Returns: Promise<{ success: boolean }>

Example:

await client.integration.delete("int_abc123");

Safe Methods

All methods have corresponding *Safe variants that return Result<T> instead of throwing:

• client.integration.listSafe()
• client.integration.createSafe(input)
• client.integration.getSafe(integrationId)
• client.integration.updateSafe(integrationId, input)
• client.integration.deleteSafe(integrationId)

Example:

const result = await client.integration.createSafe({
  name: "Devin",
  provider: "devin",
  apiKey: process.env.DEVIN_API_KEY,
});

if (result.error) {
  console.error(result.error.message);
} else {
  console.log(result.data.id);
}

Types

IntegrationProvider

type IntegrationProvider = "devin" | "cursor";

CreateIntegrationInput

type CreateIntegrationInput = {
  name: string;
  provider: IntegrationProvider;
  apiKey: string;
  metadata?: Record<string, unknown>;
};

UpdateIntegrationInput

type UpdateIntegrationInput = {
  name?: string;
  apiKey?: string;
  metadata?: Record<string, unknown>;
};

Integration

type Integration = {
  id: string;
  organizationId: string;
  name: string;
  provider: IntegrationProvider;
  apiKey: string; // Always returns "***" for security
  metadata: Record<string, unknown> | null;
  createdBy: string;
  createdAt: string;
  updatedAt: string;
  deletedAt: string | null;
};

HTTP Endpoints

Create Integration

POST /v0/integrations

Request Body:

{
  "name": "Devin Production",
  "provider": "devin",
  "apiKey": "devin_api_key_here",
  "metadata": {
    "environment": "production"
  }
}

List Integrations

GET /v0/integrations

Get Integration

GET /v0/integrations/:integrationId

Update Integration

PUT /v0/integrations/:integrationId

Request Body:

{
  "name": "Updated Name",
  "apiKey": "new_api_key_here",
  "metadata": {
    "version": "v2"
  }
}

Delete Integration

DELETE /v0/integrations/:integrationId

Authentication

All API requests require authentication using your API key:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.beeps.dev/v0/integrations