Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .agents/skills/build-channels-agent/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ name: build-channels-agent
description: >-
Use for this hackathon's Slack template in apps/channel-slack: CopilotKit
Channels setup, thread context, tools, and native cards. Read before editing
that app. This skill does not apply to the independent OpenAI Agents SDK +
Auth0 WhatsApp template or to the CopilotKit React web template.
that app. The WhatsApp template has its own direct Meta adapter guide;
this skill does not configure that app or the CopilotKit React web template.
---

# Build the Slack template with Channels

**Hackathon scope:** apply this skill to `templates/slack.md` and `apps/channel-slack/`. Other adapters below are SDK reference material, not instructions to migrate the WhatsApp template. Preserve the repository's pinned Channels/runtime pair instead of installing the older illustrative versions below.
**Hackathon scope:** apply this skill to `templates/slack.md` and `apps/channel-slack/`. For WhatsApp, follow `templates/whatsapp.md` and `apps/whatsapp/README.md`; its direct Meta adapter has different credentials and delivery behavior. Other adapters below are SDK reference material. Preserve the repository's pinned Channels/runtime pair instead of installing the older illustrative versions below.

The Channels SDK (`@copilotkit/channels`) is a **platform-agnostic engine** for
agents that live in chat. You write the logic once — handlers, tools, and
Expand Down
3 changes: 2 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ MODEL=gpt-5.6-sol
# No OpenAI key is required for OpenRouter chat.
# Get a key: https://openrouter.ai/keys
# OPENROUTER_API_KEY=
# MODEL=openai/gpt-5.6-sol
# MODEL=openai/gpt-4.1-mini
# Choose a model with tool calling for the Slack and web templates.
# With MODEL_PROVIDER unset, an OpenRouter key selects OpenRouter; otherwise
# a MODEL provider prefix selects that provider, defaulting to OpenAI.
# Existing anthropic/ and google/ model prefixes remain supported with their
Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Read [hackathon-overview.md](hackathon-overview.md), [hackathon-rules.md](hackathon-rules.md), and [using-sponsor-tools.md](using-sponsor-tools.md), then the chosen guide in `templates/`. Build the team's own workflow; the incident app is infrastructure reference code.

CopilotKit powers the Slack and web templates. `apps/whatsapp` is an independent OpenAI Agents SDK + Auth0 app with a separate install and environment; do not add Channels to it. Run its own typecheck/tests when changing it.
CopilotKit powers all three templates. `apps/whatsapp` uses the Channels direct Meta adapter, OpenAI Agents SDK, and Auth0 with its own install and environment. Run its own typecheck/tests when changing it. Preserve the tested Channels/runtime pair and verify the installed public adapter APIs; the Slack skill below remains scoped to Slack.

Read `.agents/skills/build-channels-agent/SKILL.md` before touching anything in
`apps/channel-slack/`. It carries the verified API surface; the most common
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ Your project and its core functionality must be created during the event. Existi

Three starting points for different kinds of context. **CopilotKit Channels** brings the Slack agent into the conversation; **CopilotKit React** connects the web agent to the app people are using.

**Every template supports OpenAI directly or OpenRouter.** Each guide includes both configurations; use `MODEL_PROVIDER`, the selected provider's API key, and `MODEL`. [Choose a model provider →](dev-docs/model-switching.md)

### 1. Slack — an agent that joins the thread

**OpenAI + CopilotKit Channels + Exa**
Expand All @@ -67,11 +69,11 @@ The included web app supplies page context, frontend tools, and agent-rendered U

### 3. WhatsApp — an agent you can text

**OpenAI Agents SDK + Auth0**
**OpenAI Agents SDK + CopilotKit Channels + Auth0**

An agent recognizes a linked user and requests approval on their phone before executing a protected action. The included app saves an approved, named request and returns a receipt in the conversation. Adapt that action to your own assistant.

This is an independent app with its own install and configuration. It uses OpenAI Agents SDK directly, Auth0 for identity and approval, and a WhatsApp transport. No CopilotKit account is required for this template.
This app has its own install and configuration. CopilotKit Channels connects directly to Meta's WhatsApp Cloud API, OpenAI Agents SDK proposes the action using OpenAI or OpenRouter, and Auth0 verifies identity and phone approval. Setup requires Meta, CopilotKit Intelligence, your model provider, and an Auth0 tenant with CIBA access.

**[Use the WhatsApp template →](templates/whatsapp.md)**

Expand Down
35 changes: 25 additions & 10 deletions apps/whatsapp/.env.example
Original file line number Diff line number Diff line change
@@ -1,17 +1,32 @@
# Copy to .env in this directory. Use Node.js 22+.
# Copy to .env in this directory. Use Node.js 22+. No Twilio account is used.
# Choose openai or openrouter explicitly. Only the selected provider's key is required.
MODEL_PROVIDER=openai
MODEL=gpt-4.1-mini
OPENAI_API_KEY=
OPENAI_MODEL=gpt-4.1-mini
OPENROUTER_API_KEY=
# OpenRouter example: MODEL_PROVIDER=openrouter and MODEL=openai/gpt-4.1-mini.
# MODEL takes precedence over legacy OPENAI_MODEL, which is still supported.
# OpenRouter models/endpoints must support strict JSON schema structured output.
# Tunnel ONLY the main app port. Keep the SDK listener private.
PORT=3003
# Public HTTPS origin from your tunnel, with no path. Must match both dashboards.
WHATSAPP_WEBHOOK_PORT=3004
PUBLIC_BASE_URL=https://your-tunnel.example
# Meta WhatsApp Cloud API: use the Phone Number ID, not the displayed phone number.
WHATSAPP_ACCESS_TOKEN=
WHATSAPP_PHONE_NUMBER_ID=
WHATSAPP_APP_SECRET=
# Choose your own random verification token; put the same value in Meta Webhooks.
WHATSAPP_VERIFY_TOKEN=
WHATSAPP_API_VERSION=v23.0
# CopilotRuntime owns the direct adapter lifecycle through Intelligence.
WHATSAPP_CHANNEL_NAME=whatsapp-demo
INTELLIGENCE_API_KEY=
# Auth0 confidential Regular Web Application with Authorization Code + CIBA grants.
AUTH0_ISSUER_BASE_URL=https://your-tenant.us.auth0.com
AUTH0_CLIENT_ID=
AUTH0_CLIENT_SECRET=
# Identifier of your Auth0 custom API, with the create:requests permission.
# Identifier of your RS256 Auth0 API with the create:requests permission.
AUTH0_AUDIENCE=https://whatsapp-demo.example
TWILIO_ACCOUNT_SID=
TWILIO_AUTH_TOKEN=
# Use the exact sender displayed in your own Twilio Sandbox / testing environment.
TWILIO_WHATSAPP_FROM=whatsapp:+14155238886
# Optional absolute path; default is this app's .data/state.json. Run one process only.
# DATA_FILE=/absolute/path/whatsapp-state.json
# Optional absolute path; default is this app's .data/state.json. One process only.
# Use a NEW file when migrating old Twilio state; authenticate and LINK again.
# DATA_FILE=/absolute/path/whatsapp-meta-state.json
3 changes: 3 additions & 0 deletions apps/whatsapp/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Runtime legacy optional LangChain connectors conflict with Agents SDK OpenAI 7.
# This app uses the runtime v2 Channels surface, not those optional connectors.
legacy-peer-deps=true
Loading
Loading