Articles in this section

Troubleshoot APIs

Building an API in API builder takes more than configuring requests, responses, and steps — you also need a way to confirm it works correctly and to understand what happened when it doesn't. API builder gives you three tools for that: test mode, for validating your configuration before you deploy; request history and trace view, for reviewing what happened after a request runs; and error handling controls, for shaping what your API consumers see when something fails.

Use the article that matches what you're trying to do:

  • Before you deploy your API: Run your API in test mode against mock data and review how each step behaves, without affecting live records. See Test and debug your API using API builder.
  • After your API is live: Review inbound requests in request history, turn on debug logging for more detail, and open trace view to follow a specific request step by step. See View API request and execution logs in API builder.
  • To control what consumers see when something fails: Configure your response picker, custom error responses, and response mapping so consumers receive clear, appropriate errors instead of internal details. See Error handling in API builder.

Related articles