Create bot registration endpoint #3881

tintinthong · 2026-01-21T14:58:19Z

Bot registration endpoint

Short summary of the bot registration updates in this PR, focused on the three endpoints:

Endpoints

`POST /_bot-registration`

Registers a bot for the authenticated user.
Once registered, the bot filters out events in rooms it is invited to.
Requires a realm server JWT.
matrixUserId must match the authenticated user.
Returns 201 with the created registration

`GET /_bot-registrations`

Lists bot registrations for the authenticated user only. Only gets his/her own bot registrations
Requires a realm server JWT.

`DELETE /_bot-registration`

Unregisters a bot by id for the authenticated user.
Requires a realm server JWT.
Returns 204 on success.

chatgpt-codex-connector · 2026-01-21T15:02:50Z

💡 Codex Review

boxel/packages/bot-runner/main.ts

Lines 67 to 70 in 7d0f6ff

    
           client.on(RoomEvent.Timeline, async (event, room, toStartOfTimeline) => { 
        
             if (!room || toStartOfTimeline) { 
        
               return; 
        
             }

Filter pre-start timeline events to avoid replay

The timeline handler only skips toStartOfTimeline, so historical events delivered during initial sync or after reconnect can still be processed even if they happened before this bot runner started. Matrix-js-sdk can append old events at the end of the timeline during initial sync, which means those events will pass the current guard and trigger logging/queue work. Without an origin_server_ts (or registration createdAt) check, a restart will reprocess old room history and can enqueue duplicate jobs once publishing is implemented.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

github-actions · 2026-01-21T15:05:51Z

Preview deployments

github-actions · 2026-01-21T15:22:57Z

Host Test Results

1 files ± 0 1 suites ±0 1h 25m 14s ⏱️ - 14m 59s
1 735 tests - 155 1 712 ✅ - 161 15 💤 - 2 0 ❌ ±0 8 🔥 +8
1 748 runs - 157 1 717 ✅ - 171 15 💤 - 2 8 ❌ +8 8 🔥 +8

For more details on these errors, see this check.

Results for commit 47ed4ae. ± Comparison against base commit 2ad413f.

♻️ This comment has been updated with latest results.

Copilot

Pull request overview

This PR creates a bot registration endpoint system that allows users to register Matrix bot runners with the realm server. The system tracks which users have registered bots and provides endpoints to create, list, and delete bot registrations.

Changes:

Added POST /_bot-registration endpoint for bot registration
Added GET /_bot-registrations endpoint to list all bot registrations
Added DELETE /_bot-registration endpoint for unregistering bots
Created database migration for bot_registrations table
Added comprehensive test coverage with 8 test cases
Included shell script for easy bot registration
Added documentation for the generic bot runner system

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
`packages/realm-server/handlers/handle-bot-registration.ts`	Implements three handler functions for bot registration, listing, and unregistration with JWT authentication
`packages/realm-server/routes.ts`	Registers three new routes with JWT middleware for bot registration operations
`packages/realm-server/tests/server-endpoints/bot-registration-test.ts`	Comprehensive test suite covering authentication, registration, updates, authorization, and listing scenarios
`packages/realm-server/tests/index.ts`	Imports the new test file into the test suite
`packages/postgres/migrations/1769200000000_create-bot-registrations.js`	Creates bot_registrations table with id, user_id, and created_at columns plus unique constraint
`packages/realm-server/scripts/register-bot.sh`	Shell script for registering bots via curl with configurable environment variables
`docs/generic-bot-runner.md`	Documentation covering bot registration process, endpoints, and bot runner configuration

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

packages/realm-server/tests/server-endpoints/bot-registration-test.ts

packages/realm-server/handlers/handle-bot-registration.ts

packages/postgres/migrations/1769200000000_create-bot-registrations.js

tintinthong · 2026-01-22T12:33:47Z

@codex review

Copilot

Pull request overview

Copilot reviewed 15 out of 16 changed files in this pull request and generated 6 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

packages/realm-server/tests/server-endpoints/bot-registration-test.ts

packages/host/app/services/realm-server.ts

packages/realm-server/tests/server-endpoints/bot-registration-test.ts

docs/generic-bot-runner.md

packages/bot-runner/main.ts

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 66e83752aa

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

packages/bot-runner/main.ts

Copilot · 2026-01-22T13:22:29Z

@tintinthong I've opened a new pull request, #3888, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot

Pull request overview

Copilot reviewed 16 out of 17 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

packages/realm-server/tests/server-endpoints/bot-registration-test.ts

packages/host/app/services/realm-server.ts

tintinthong · 2026-01-22T14:39:19Z

packages/postgres/migrations/1769200000000_create-bot-registrations.js

+exports.up = (pgm) => {
+  pgm.createTable('bot_registrations', {
+    id: { type: 'uuid', primaryKey: true, notNull: true },
+    user_id: { type: 'uuid', notNull: true },
+    name: { type: 'text' },
+    created_at: { type: 'timestamp', notNull: true },
+  });
+  pgm.addConstraint('bot_registrations', 'bot_registrations_user_name_unique', {
+    unique: ['user_id', 'name'],
+  });
+  pgm.addConstraint('bot_registrations', 'bot_registrations_user_id_fkey', {
+    foreignKeys: {
+      columns: 'user_id',
+      references: 'users(id)',
+      onDelete: 'CASCADE',
+    },
+  });
+};


this is the schema. Im not sure if we want matrix_user_id here but given the users table already has it maybe I don't need redundancy? Or we can just keep this table be simple and only have matrix_user_id without the user_id?

Also, I added name that shud be unique per user so ppl can name their bots registrations -- this is optional

@lukemelia

tintinthong changed the base branch from main to create-bot-runner-package January 21, 2026 15:02

habdelra requested a review from Copilot January 21, 2026 21:14

Copilot started reviewing on behalf of habdelra January 21, 2026 21:15 View session

Copilot AI reviewed Jan 21, 2026

View reviewed changes

tintinthong force-pushed the create-bot-registration branch from a16203f to 66e8375 Compare January 22, 2026 12:29

tintinthong requested a review from Copilot January 22, 2026 12:33

Copilot started reviewing on behalf of tintinthong January 22, 2026 12:34 View session

Copilot AI reviewed Jan 22, 2026

View reviewed changes

chatgpt-codex-connector bot reviewed Jan 22, 2026

View reviewed changes

packages/bot-runner/main.ts Outdated Show resolved Hide resolved

Copilot AI mentioned this pull request Jan 22, 2026

[WIP] Update bot registration endpoint implementation based on feedback #3888

Closed

tintinthong requested a review from Copilot January 22, 2026 13:23

Copilot started reviewing on behalf of tintinthong January 22, 2026 13:23 View session

Copilot AI reviewed Jan 22, 2026

View reviewed changes

packages/realm-server/tests/server-endpoints/bot-registration-test.ts Outdated Show resolved Hide resolved

packages/host/app/services/realm-server.ts Outdated Show resolved Hide resolved

tintinthong commented Jan 22, 2026

View reviewed changes

tintinthong force-pushed the create-bot-runner-package branch from 2ad413f to 2654e2a Compare January 22, 2026 14:52

tintinthong added 10 commits January 22, 2026 22:52

add bot registration endpoint

a35d841

add script to register bot

bbdea7e

add register bot commands

4464b1b

update generic bot runner

479dba4

fix copilot recommendations

53949a7

fix handling of bot runner with registrations.

cebc082

fix tests + fix copilot recommendations

22d1c0b

include accept header and content type for test

407a435

cleanup code

5c141aa

get type of full row

972e90d

tintinthong force-pushed the create-bot-registration branch from 47ed4ae to 972e90d Compare January 22, 2026 14:54

Create bot registration endpoint #3881

Are you sure you want to change the base?

Create bot registration endpoint #3881

Conversation

tintinthong commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bot registration endpoint

Endpoints

POST /_bot-registration

GET /_bot-registrations

DELETE /_bot-registration

Uh oh!

chatgpt-codex-connector bot commented Jan 21, 2026

💡 Codex Review

Uh oh!

github-actions bot commented Jan 21, 2026

Preview deployments

Uh oh!

github-actions bot commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Host Test Results

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tintinthong commented Jan 22, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Copilot AI commented Jan 22, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

tintinthong Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

tintinthong commented Jan 21, 2026 •

edited

Loading

`POST /_bot-registration`

`GET /_bot-registrations`

`DELETE /_bot-registration`

github-actions bot commented Jan 21, 2026 •

edited

Loading

tintinthong Jan 22, 2026 •

edited

Loading