Endpoints

Endpoints are custom styling, channel configurations, or customization for a bot specific to an omnichannel entrypoint. These can be used to display different styling for bots on different domains, or for sub brands. They can also be configured to support interactions with specific channels such as Alexa, or Whatsapp. Not to be confused with API endpoints.

It is possible to have a bot engage with users using more than one endpoint.

Each bot gets created with an default engagement adapter/type when it is created. The default endpoint type is servisbot messenger

Endpoint Types

Your endpoint type determines what engagement adapter will be used to expose your bot user interactions. The default type is a ServisBOT web messenger type.

By changing your Endpoint type, you are given further configurations for turning on your engagement adapter

Endpoint through the CLI

You can find the a bot endpoint and its settings through the CLI

sb-cli endpoint list

it will return the bot settings including the endpoint currently set.

{
    "Address": "someaddress",                   /* Required */
    "Name": "somename",                         /* Required */
    "Status": "online",                         /* Required */
    "TargetVAReference": "avareference",        /* Required if TargetBotReference is not provided */
    "TargetBotReference": "abotreference",      /* Optional */
    "InboundBotReference": "abotreference",     /* Optional */
    "OutboundBotReference": "abotreference",    /* Optionl */
    "Useragent": "useragent",                   /* Required */
    "Style": {                                  /* Optional */
      "some": "styling"
    },
    "AllowedDomains": ["some-domain", "*", "*.domain.com"],  /* Optional */
    "EngagementType" : "engagement-adapter-type", /* Optional - defaults to lightning */
    "EngagementConfig" : {                    /* Required if EngagementType is MicrosoftBotFramework */
        "Secret": "secret-srn",
        "Public": {
          "TenantId" : "tenantid"
        }
    }
}

Styles live inside the “Style” object.

Example styling

        "name": "name",
        "avatar": "https://s3-eu-west-1.amazonaws.com/sborg-heupper-chillinsurance/forge/settings/6o4MqCMzL",
        "subtitle": "Helping You Complete Your Insurance",
        "background": "https://s3-eu-west-1.amazonaws.com/sborg-heupper-chillinsurance/forge/settings/CKBOJWq1Q",
        "messengerBackgroundColor": "#ffffff",
        "headerBackgroundColor": "#4a2783",
        "headerTextColor": "#ffffff",
        "roundelBackgroundColor": "#4a2783",
        "roundelIconColor": "#ffffff",
        "inboundMessageBackgroundColor": "#FFFFFF",
        "inboundMessageTextColor": "#3B3E3F",
        "inboundMessageTextColorSecondary": "#713f98",
        "outboundMessageBackgroundColor": "#713f98",
        "outboundMessageTextColor": "#ffffff",
        "promptHeaderBackgroundColor": "#a7c539",
        "promptHeaderTextColor": "#FFFFFF",
        "promptTextColor": "#a7c539",
        "footerBackgroundColor": "#FFFFFF",
        "footerTextColor": "#999999"