Configure the output response REST endpoint and outbound authentication for the Virtual Agent API

Specify the outbound endpoint URL to which the Virtual Agent responses are posted. Configure outbound authentication.

Before you begin

If needed, specify the Message Authentication for token validation in the Provider Channel Identities [sys_cs_provider_application] table.

Role required: admin

Procedure

1. Navigate to All > System Web Services > Outbound > REST Message.
2. Select the VA Bot to Bot record to open it.
3. In the Endpoint field, enter the response endpoint for the third-party bot, and then click Update.

   This is the endpoint for the primary bot server, where the response will have to be sent from the ServiceNow bot to another bot or another ServiceNow instance.

   For example: http://<customer instance>/demo/rest/service/nowbot/processResponse

4. In the Authentication tab, set the Authentication type field to either Basic or OAuth 2.0, and then click Update.
   • Basic: In the Basic auth profile field, select or create a Basic auth profile. It will contain a username and password.

     

   • OAuth: In the OAuth profile field, select or create an OAuth profile. After saving your changes, click Get OAuth Token in the related links list.

   For details about configuring basic authentication, see Configure a REST message with basic auth. For information about configuring OAuth 2.0, see Configure a REST message with OAuth.

5. Review the JSON response returned from the endpoint call.
   For a description of the Virtual Agent API response parameters and an example of a successful response, see Virtual Agent Bot Integration API.