SDKs & Integrations - Copera Public API

Overview

Integrate Copera into your development workflow with our official tools:

Backend SDK: Full-featured Node.js/TypeScript SDK for API integration
CI/CD: GitHub Actions for automated notifications in your workflows

Choose the integration method that best fits your needs.

Backend
CI/CD

Node.js SDK

@copera.ai/sdk

Official Node.js/TypeScript SDK for the Copera Public API

Installation

npm install @copera.ai/sdk

Requirements

Node.js 18 or higher
API Key from your Copera integration

Quick Start

import { CoperaAI } from '@copera.ai/sdk';

// Initialize the SDK
const copera = CoperaAI({
  apiKey: 'your-api-key-here'
});

// Send a message to a channel
await copera.channel.sendMessage({
  channelId: 'channel_id_here',
  message: 'Hello from Copera.ai SDK!',
  name: 'Bot Name' // optional
});

// List all boards
const boards = await copera.board.listBoards();
console.log(boards);

Available Methods

Channel Methods

sendMessage

Send a text message to a channel.

await copera.channel.sendMessage({
  channelId: 'channel_id',
  message: 'Your message here',
  name: 'Optional sender name'
});

Board Methods

listBoards

Retrieve all boards in the workspace.

const boards = await copera.board.listBoards();

getBoardDetails

Get details of a specific board.

const board = await copera.board.getBoardDetails('board_id');

listBoardTables

List all tables in a board.

const tables = await copera.board.listBoardTables('board_id');

getBoardTable

Get details of a specific table.

const table = await copera.board.getBoardTable({
  boardId: 'board_id',
  tableId: 'table_id'
});

listTableRows

List all rows in a table.

const rows = await copera.board.listTableRows({
  boardId: 'board_id',
  tableId: 'table_id'
});

getTableRow

Get a specific row from a table.

const row = await copera.board.getTableRow({
  boardId: 'board_id',
  tableId: 'table_id',
  rowId: 'row_id'
});

createTableRow

Create a new row in a table.

const newRow = await copera.board.createTableRow({
  boardId: 'board_id',
  tableId: 'table_id',
  columns: [
    {
      columnId: 'column_id_1',
      value: 'Value 1'
    },
    {
      columnId: 'column_id_2',
      value: 'Value 2'
    }
  ],
  description: 'Optional description'
});

Environment Configuration

Development Environment

import { CoperaAI } from '@copera.ai/sdk';

const copera = CoperaAI({
  apiKey: process.env.COPERA_API_KEY,
  // SDK automatically uses production API
});

Sandbox Mode

For testing, you can use the sandbox environment:

const copera = CoperaAI({
  apiKey: process.env.COPERA_SANDBOX_API_KEY,
  sandbox: true
});

Error Handling

The SDK provides detailed error messages:

try {
  await copera.channel.sendMessage({
    channelId: 'invalid_id',
    message: 'Test message'
  });
} catch (error) {
  console.error('Error:', error.message);
  // Handle error appropriately
}

TypeScript Support

The SDK is built with TypeScript and provides full type definitions:

import type { Board, BoardTable, BoardTableRow } from '@copera.ai/sdk';

// All types are exported and available
const boards: Board[] = await copera.board.listBoards();

Need Help?

Found a bug or have a feature request?

Report an Issue

Open an issue on GitHub for the Node.js SDK

GitHub Action

Copera Action

Send messages to Copera channels directly from your GitHub workflows

Integrate Copera notifications into your CI/CD pipeline with our official GitHub Action.

Features

Workflow Integration: Send messages directly from GitHub Actions
Custom Notifications: Notify your team about deployments, releases, and events
Easy Setup: Simple configuration with GitHub Secrets
Built on Official API: Uses the same reliable Copera Public API
Debug Mode: Detailed logging for troubleshooting

Quick Start

Add this to your GitHub workflow:

name: Deploy Notification

on:
  push:
    branches: [main]

jobs:
  notify:
    runs-on: ubuntu-latest
    steps:
      - name: Send Copera Notification
        uses: copera-ai/[email protected]
        with:
          api_token: ${{ secrets.COPERA_API_TOKEN }}
          channel_id: ${{ secrets.COPERA_CHANNEL_ID }}
          message: "🚀 New deployment to production!"
          sender_name: "GitHub Actions"

Configuration

api_token

string

required

Your Copera API token. Store this in GitHub Secrets.

channel_id

string

required

The channel ID where messages will be sent. Get this from Developer Mode.

message

string

required

The message content (1-10,000 characters).

sender_name

string

Optional custom sender name to display.

debug

boolean

default:"false"

Enable detailed logging for troubleshooting.

Setup Guide

Create Integration

Go to Copera.ai and create a new API integration in your workspace settings.

Generate API Token

Copy your API token from the integration settings.

Get Channel ID

Enable Developer Mode in Copera, then copy the channel ID where you want to send messages.

Add GitHub Secrets

In your repository settings, add:

COPERA_API_TOKEN: Your API token
COPERA_CHANNEL_ID: Your target channel ID

Add to Workflow

Use the action in your .github/workflows YAML files.

Use Cases

Deployment Notifications

Notify your team when new deployments happen:

- name: Deployment Success
  uses: copera-ai/[email protected]
  with:
    api_token: ${{ secrets.COPERA_API_TOKEN }}
    channel_id: ${{ secrets.COPERA_CHANNEL_ID }}
    message: "✅ Successfully deployed to production - ${{ github.sha }}"
    sender_name: "Deploy Bot"

Pull Request Updates

Alert the team about new pull requests:

- name: New PR Notification
  uses: copera-ai/[email protected]
  with:
    api_token: ${{ secrets.COPERA_API_TOKEN }}
    channel_id: ${{ secrets.COPERA_CHANNEL_ID }}
    message: "🔍 New PR: ${{ github.event.pull_request.title }} by ${{ github.actor }}"
    sender_name: "PR Bot"

Test Failures

Get notified when tests fail:

- name: Test Failure Alert
  if: failure()
  uses: copera-ai/[email protected]
  with:
    api_token: ${{ secrets.COPERA_API_TOKEN }}
    channel_id: ${{ secrets.COPERA_CHANNEL_ID }}
    message: "❌ Tests failed in ${{ github.repository }} - Check workflow run"
    sender_name: "Test Bot"

Release Announcements

Announce new releases:

- name: Release Announcement
  uses: copera-ai/[email protected]
  with:
    api_token: ${{ secrets.COPERA_API_TOKEN }}
    channel_id: ${{ secrets.COPERA_CHANNEL_ID }}
    message: "🎉 New release ${{ github.ref_name }} is now available!"
    sender_name: "Release Bot"

Troubleshooting

Enable debug mode to see detailed logs:

with:
  debug: true

Make sure your integration has the necessary permissions to send messages to the target channel.

Common error codes and solutions:401 Unauthorized - Check that your API token is valid403 Forbidden - Verify the integration has access to the channel404 Not Found - Ensure the channel ID is correct

Need Help?

Found a bug or have a feature request?

Report an Issue

Open an issue on GitHub for the Copera Action

Support

Need help with the SDK or GitHub Action?

Documentation

Check our complete API documentation

Support

Contact our support team

SDK Issues

Report SDK bugs or request features

Action Issues

Report Action bugs or request features

Developer Mode

Learn about Developer Mode

Coming Soon

We’re working on additional SDKs for:

Python
Go
PHP
Ruby

Stay tuned for updates!

API Guides

Board

Channel

​Overview

​Node.js SDK

@copera.ai/sdk

​Installation

​Requirements

​Quick Start

​Available Methods

​Channel Methods

​Board Methods

​Environment Configuration

​Development Environment

​Sandbox Mode

​Error Handling

​TypeScript Support

​Need Help?

Report an Issue

​GitHub Action

Copera Action

​Features

​Quick Start

​Configuration

​Setup Guide

​Use Cases

​Troubleshooting

​Need Help?

Report an Issue

​Support

Documentation

Support

SDK Issues

Action Issues

Developer Mode

​Coming Soon

Overview

Node.js SDK

Installation

Requirements

Quick Start

Available Methods

Channel Methods

Board Methods

Environment Configuration

Development Environment

Sandbox Mode

Error Handling

TypeScript Support

Need Help?

GitHub Action

Features

Quick Start

Configuration

Setup Guide

Use Cases

Troubleshooting

Need Help?

Support

Coming Soon