Review the inbound REST endpoint and configure inbound authentication

Watch

Save as PDF

Share this page

Feedback

After you install the Virtual Agent API, navigate to the Scripted REST API resource to review the endpoint and set up authentication.

Before you begin

Role required: admin

Procedure

Navigate to All > System Web Services > Scripted Web Services > Scripted REST APIs.
Select the VA Bot Integration record to open it.
In the Resources tab, open the BOT Integration record.
Review the inbound REST API resource details.

The format is: https://<customer instance>/api/sn_va_as_service/bot/integration

For a description of the request parameters and an example send request, see Virtual Agent Bot Integration API.
In the Security tab on the same page, select the Requires authentication check box.
Set up Provider Authentication using any of these methods: Basic, OAuth, Hash, or Static Token.
Note: Guest usage via Basic or OAuth is already supported out-of-box when you select Requires authentication. To support user account linking, you must use Static or Hash token-based authentication. You can use token-based authentication (Static or Hash) with or without Basic or OAuth authentication. The token can be passed in either the request body or the header. If the token is specified in both places, the one in the header is accepted.
Do one of the following:
- Set up Basic or OAuth authentication.
  To learn more about OAuth authentication and the possible security configurations for scripted REST APIs, see Enable OAuth with inbound REST.
- Set up Message Authentication, which involves configuring either Static or Hash tokens, setting up Provider Authentication, and setting the channel identity. For details, see Configure Message Authentication for inbound communication.