Register bot with Khoros Care

post https://{instance}.response.lithium.com/api/v2/bots/networks/{networkType}/registrations

Recipes

Create a Monitoring Bot

Open Recipe

Details

Registers a bot with Khoros Care. This is a one-time action per unique bot.

The Content-Type must be application/x-www-form-urlencoded.

📘
Note
The username and password in this call are for the authentication on the callback URL, not the credentials for making this API call. To make this API call, you will need to set a Basic Auth header on your request using the username and password of the user in Care that has the Bot API permission granted.

Path Params

networkType

string

required

The type of source channel. Supported values: facebook, twitter

Body Params

externalId

string

required

(Required) The numeric ID of the entity the bot will communicate on behalf of on the source channel (i.e., the brand page ID on Facebook or the brand). Only one bot registration per external ID is allowed.

appId

string

required

(Required) The app ID of the associated social network app that is used by the bot. This is used as the unique identifier for the bot in Response.

callbackUrl

string

required

(Required) A URL that will be used to make callback to the bot from Lithium. The value must be URL-encoded and use HTTPS. If HTTPS is not used for the callback URL, the call will fail. See API callbacks to bots for more information. Note: If using the Facebook Handover Protocol, enter a dummy value. This field is not used by the Facebook Handover Protocol, but is still required by the call.

authenticationType

string

required

(Required) The authentication type to be used when Response performs a callback to the bot. The value is always BASIC_AUTH. Note: If using the Facebook Handover Protocol, enter a dummy value. This field is not used by the Facebook Handover Protocol, but is still required by the call.

username

string

required

(Required) The user name used to authenticate the callback to the bot via Basic Auth. The user name is part of the credentials that correspond to an entity on the bot. Note: If using the Facebook Handover Protocol, enter a dummy value. This field is not used by the Facebook Handover Protocol, but is still required by the call.

password

string

required

(Required) The password used to authenticate the callback to the bot. The password is part of the credentials that correspond to an entity on the bot. Note: If using the Facebook Handover Protocol, enter a dummy value. This field is not used by the Facebook Handover Protocol, but is still required by the call.

Responses

Language

URL

Request


xxxxxxxxxx
1
curl -X POST \
2
'https://mycompany.response.lithium.com/api/v2/bots/networks/twitter/registrations' \
3
  -F 'externalId=12345678909876' \
4
  -F 'appId=abc123' \
5
  -F 'authenticationType=BASIC_AUTH' \
6
  -F 'username=foo' \
7
  -F 'password=bar'
8
  -F 'callbackUrl=https://dummy.example.com'

Choose an example:

application/json

Details

📘Note

200200

400400

📘
Note