Connect Messaging Channels

Check the channel ingress capabilities advertised by your deployment, create a managed Slack Socket Mode connection for an agent, and verify connection state and live message delivery.

Task flow

List advertised channel ingress capabilities
                     │
                     ▼
Create a Slack managed_stream connection
                     │
                     ▼
Check observed_state until connected
                     │
                     ▼
Send a Slack test message and verify the reply

Prerequisites

  1. Complete the endpoint, personal access token, and workspace setup in Use the SDK.

  2. Obtain the target agent ID (AGENT_ID) and source workspace ID (AGENT_WORKSPACE_ID) via Discover and Select Agents, and choose an execution model (AGENT_MODEL) via Inspect Model Backends and Endpoints.

  3. Follow Configure Slack to prepare your Slack app credentials and export App ID (SLACK_APP_ID), App-Level Token (SLACK_APP_TOKEN), and Bot Token (SLACK_BOT_TOKEN) in protected environment variables.

Check capabilities and create a managed connection

Call list_ingress_capabilities (ListIngressCapabilities in Go) to verify that Slack managed_stream ingress is enabled on the deployment, then call create_ingress_connection (CreateIngressConnection in Go) to bind the agent and Slack credentials.

import os

import moi_product_sdk as sdk

client = sdk.new_with_personal_access_token(
    os.environ["PRODUCT_API_BASE_URL"],
    os.environ["PRODUCT_API_KEY"],
)
service = client.agents(os.environ["WORKSPACE_ID"])

capabilities = service.list_ingress_capabilities()
if not any(
    item.provider == "slack"
    and item.channel_type == "slack_app"
    and "managed_stream" in item.receive_modes
    for item in capabilities.items
):
    raise SystemExit("Slack managed streams are not advertised on this deployment")

connection = service.create_ingress_connection(
    sdk.IngressConnectionCreateRequest(
        target=sdk.AgentTargetRef(
            kind="agent",
            workspace_id=os.environ["AGENT_WORKSPACE_ID"],
            id=os.environ["AGENT_ID"],
        ),
        provider="slack",
        channel_type="slack_app",
        receive_mode="managed_stream",
        agent_model=os.environ["AGENT_MODEL"],
        managed_stream=sdk.IngressManagedStreamConfig(
            app_id=os.environ["SLACK_APP_ID"],
            app_token=os.environ["SLACK_APP_TOKEN"],
            bot_token=os.environ["SLACK_BOT_TOKEN"],
        ),
    )
)
print("Connection:", connection.id, "Versions:", connection.association_version, connection.config_version)
print("State:", connection.desired_state, connection.observed_state, connection.last_error_code)
package main

import (
	"context"
	"fmt"
	"log"
	"os"

	sdk "github.com/matrixorigin/matrixflow/sdk/go-sdk"
)

func main() {
	ctx := context.Background()
	client, err := sdk.NewWithPersonalAccessToken(
		os.Getenv("PRODUCT_API_BASE_URL"),
		os.Getenv("PRODUCT_API_KEY"),
	)
	if err != nil {
		log.Fatal(err)
	}
	defer client.Close()

	service := client.Agents(os.Getenv("WORKSPACE_ID"))
	capabilities, err := service.ListIngressCapabilities(ctx)
	if err != nil {
		log.Fatal(err)
	}
	supported := false
	for _, item := range capabilities.GetItems() {
		if item.GetProvider() == "slack" && item.GetChannelType() == "slack_app" {
			for _, mode := range item.GetReceiveModes() {
				if mode == "managed_stream" {
					supported = true
				}
			}
		}
	}
	if !supported {
		fmt.Println("Slack managed streams are not advertised on this deployment")
		return
	}

	connection, err := service.CreateIngressConnection(ctx, sdk.IngressConnectionCreateRequest{
		Target: &sdk.AgentTargetRef{
			Kind:        "agent",
			WorkspaceId: os.Getenv("AGENT_WORKSPACE_ID"),
			Id:          os.Getenv("AGENT_ID"),
		},
		Provider:    "slack",
		ChannelType: "slack_app",
		ReceiveMode: "managed_stream",
		AgentModel:  os.Getenv("AGENT_MODEL"),
		ManagedStream: &sdk.IngressManagedStreamConfig{
			AppID:    os.Getenv("SLACK_APP_ID"),
			AppToken: os.Getenv("SLACK_APP_TOKEN"),
			BotToken: os.Getenv("SLACK_BOT_TOKEN"),
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("Connection:", connection.GetId(), "Versions:", connection.GetAssociationVersion(), connection.GetConfigVersion())
	fmt.Println("State:", connection.GetDesiredState(), connection.GetObservedState(), connection.GetLastErrorCode())
}

Record the returned connection id, association_version, and config_version for optimistic concurrency control when updating or disabling the connection later.

Verify connection state and message delivery

For Slack managed_stream connections, the platform receiver establishes the outbound Socket Mode stream automatically. Continue from the previous step by calling get_ingress_connection (GetIngressConnection in Go) to inspect observed_state and last_error_code:

current = service.get_ingress_connection(connection.id)
print(current.desired_state, current.observed_state, current.last_error_code)
if current.observed_state in ("auth_failed", "config_invalid"):
    raise RuntimeError("Correct the Slack credentials or connection configuration")
if current.observed_state != "connected":
    print("Receiver is still connecting; check observed_state again before testing delivery")
current, err := service.GetIngressConnection(ctx, connection.GetId())
if err != nil {
	log.Fatal(err)
}
fmt.Println(current.GetDesiredState(), current.GetObservedState(), current.GetLastErrorCode())
if current.GetObservedState() == "auth_failed" || current.GetObservedState() == "config_invalid" {
	log.Fatal("correct the Slack credentials or connection configuration")
}
if current.GetObservedState() != "connected" {
	fmt.Println("Receiver is still connecting; check observed_state again before testing delivery")
}

Limitations and notes

  • An observed_state of starting or reconnecting indicates that the receiver is still establishing or restoring the stream. Once observed_state reaches connected, send a test message to the app in Slack and verify the agent’s conversation records and reply.

  • Updating connection settings or target bindings requires passing the latest association_version and config_version; on a version conflict, read back the latest connection object before retrying.

Next steps

Last updated on