Note:
The import command creates a new channel or updates an existing one based on the name. If a channel with the same name exists, the command updates it using the new configuration.
Channel-specific fields, such as authentication fields.
Note:
YAML and JSON files support one channel specification per file. Python files support multiple channel instances in one file. You can define only one instance per channel type in each environment. For example, you can define both a Twilio WhatsApp channel and a Slack channel, but not two Twilio WhatsApp channels in the same environment.
Note:
Sensitive credential fields such as authentication tokens, secrets, and passwords appear as null or blank values in the output. This protects your credentials from accidental exposure.
Note:
Sensitive credential fields such as authentication tokens, secrets, and passwords appear as null or blank values in the exported file. This protects your credentials from accidental exposure. You need to manually add these values when importing the channel into a new environment.
Important:
When you delete a channel, it stops receiving messages from the external platform immediately. You cannot undo this action, so make sure you want to remove the channel before you proceed.
Use web chat to embed a chat widget in your website or web application.
Note:
Web chat uses a dedicated workflow. Unlike other channel types, you manage web chat channels with a specialized command. Standard operations such as create, list-channels, get, export, and delete do not apply. For full integration steps, see Agent Integration Guide.
name: "WhatsApp Support"description: "Customer support via WhatsApp"channel: "twilio_whatsapp"spec_version: "v1"kind: "channel"account_sid: "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"twilio_authentication_token: "your_auth_token_here"
Using Python:
Python
Copy
Ask AI
from ibm_watsonx_orchestrate.agent_builder.channels import TwilioWhatsappChannelwhatsapp = TwilioWhatsappChannel( name="WhatsApp Support", description="Customer support via WhatsApp", account_sid="ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", twilio_authentication_token="your_auth_token_here")
name: "SMS Support"description: "Customer support via SMS"channel: "twilio_sms"spec_version: "v1"kind: "channel"account_sid: "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"twilio_authentication_token: "your_auth_token_here"phone_number: "+1234567890"
Using Python:
Python
Copy
Ask AI
from ibm_watsonx_orchestrate.agent_builder.channels import TwilioSMSChannelsms = TwilioSMSChannel( name="SMS Support", description="Customer support via SMS", account_sid="ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", twilio_authentication_token="your_auth_token_here", phone_number="+1234567890")
Connect your agent to Genesys Cloud using the Bot Connector integration.For detailed setup instructions, see Integrating Genesys Bot Connector in the IBM watsonx Orchestrate documentation.
Verification Token (any secure random string you choose)
Important: The Verification Token is not obtained from Genesys Cloud. You create this value yourself (it can be any secure random string). You must configure this same value in both:
Your ADK channel configuration (as verification_token)
Your Genesys Cloud Bot Connector integration settings (go to the Credentials tab and add a key-value pair: key=x-watson-genesys-verification-token, value=your random string)
Remember to use the same value in your ADK configuration and in the Genesys Bot Connector Credentials tab (with key x-watson-genesys-verification-token).
Use one of the following methods to define the channel:Using YAML:
Copy
Ask AI
spec_version: v1kind: channel# Required: Channel type identifierchannel: teams# Required: Name for this channel instancename: production_teams_channel# Optional: Description of this channeldescription: Main customer support Microsoft Teams channel for production environment# Required: Microsoft App Client secret (from Certificates & secrets)app_password: ${TEAMS_APP_PASSWORD}# Required: Microsoft Application (client) IDapp_id: ${TEAMS_APP_ID}# Optional: Microsoft Teams tenant ID (also called Directory ID)teams_tenant_id: ${TEAMS_TENANT_ID}
Using Python:
Copy
Ask AI
import osfrom ibm_watsonx_orchestrate.agent_builder.channels import TeamsChannelfrom dotenv import load_dotenvload_dotenv()channel = TeamsChannel( name="production_teams_channel", description="Main customer support Microsoft Teams channel for production environment", app_password=os.getenv("TEAMS_APP_PASSWORD"), app_id=os.getenv("TEAMS_APP_ID"), teams_tenant_id=os.getenv("TEAMS_TENANT_ID"))
Use one of the following methods to define the channel.Using YAML:
Copy
Ask AI
# Facebook Messenger Channel Configuration Examplespec_version: v1kind: channel# Required: Channel type identifierchannel: facebook# Required: Name for this channel instancename: production_facebook_channel# Optional: Description of this channeldescription: Main customer support Facebook Messenger channel for production environment# Required: Facebook app secretapplication_secret: ${FACEBOOK_APP_SECRET}# Required: Page access token for the Facebook pagepage_access_token: ${FACEBOOK_PAGE_ACCESS_TOKEN}# Required: Verification token for webhook verification This can be any string value you come up with. # You will have to enter the same string when you complete the Webhooks configuration on Facebook's side.verification_token: ${FACEBOOK_VERIFICATION_TOKEN}
Using Python:
Copy
Ask AI
import osfrom ibm_watsonx_orchestrate.agent_builder.channels import FacebookChannelfrom dotenv import load_dotenvload_dotenv()# Define the Facebook Messenger channel configurationchannel = FacebookChannel( name="production_facebook_channel", description="Main customer support Facebook Messenger channel for production environment", application_secret=os.getenv("FACEBOOK_APP_SECRET"), verification_token=os.getenv("FACEBOOK_VERIFICATION_TOKEN"), page_access_token=os.getenv("FACEBOOK_PAGE_ACCESS_TOKEN"))
