Troubleshooting and maintenance

Monitor requests and errors to catch issues early.

You can monitor all of Agent Connect requests and any errors encountered on the API status page. On the Settings page, click the "Integrations" tile, then click the API Status Page link:

image of the API status page link

Two types of requests are logged on the status page:

  • All errors in request processing from either the test or production API keys will show in the Invalid tab.

  • All requests made from the test API key will show on the Test Requests tab.

image of the invalid requests page

To understand the different errors you may see on this page, consult the definitions below.

Employee profile not complete
The employee was found but does not have a complete and approved profile.
Deactivated employee
This employee was found but has been deactivated and would need to be reactivated in order to send Feedback requests.
Employee not found
This employee could not be found. The employee's email address will be displayed in the adjacent column.
Invalid customer
There was an issue with the format of the name or email that was provided.
Channel not enabled for company
This channel has not been enabled on the Company Info page. If you need to enable a new channel, review all questions and settings on the Survey Builder page for that channel to customize the Feedback survey.
Channel is in manual mode
This error will only show if you are using a production API key but have not switched that channel from manual to integrated mode.
Brand signifier not provided
Your company has multiple brands but the API request did not specify a brand label.
Invalid/inactive brand signifier

This error will show in one of two instances:

  1. The brand label in your API request does not match any of the brands found on the Company Info page, or...

  2. The brand was found but has not been activated.

Language not specified
Your company is set up with multiple active languages but the API request did not specify a language.
Language not available/active

This error will show in one of two instances:

  1. The language specified in the API request does not match any of the languages set up for your company, or...

  2. The language was found but has not been activated.