Skip to content

Connect your own system ​

For chat tasks, use the Mattermost connector. For merge request reviews, use the GitLab connector.

A connector turns events from your system into Orpheus assignments. It can be a small service, webhook handler or scheduled job.

text
New ticket → connector → POST /sessions → agent
                                           ↓
Helpdesk ← agent API call or after_run ← result

Assign responsibilities ​

Your integrationOrpheusAgent
Select events and gather contextExecute work and retain historySolve the task with available tools
Associate source objects with sessionsAccept new runs and clarificationsPrepare a reply or file
Define delivery and retriesExpose states, events and resultsFollow the supplied instructions

The API accepts arrays of text messages. Prepare files in the sandbox separately. The source of a task and its destination can be different systems.

A separate session for each event is enough for a simple connector. For a chat connector, choose allow_multiple_runs: true to continue the conversation in one session. Set up result delivery and retry handling.

Examples use Python's standard library. They demonstrate individual operations rather than a complete webhook server. A Go client is also available.