Viewing and Troubleshooting API Messages

Every API call is stored as an API message in Business Central, with the request, response, and related data, which is useful for testing and troubleshooting.

The Five Stages of an API Message

1. Message Initialization
   1. The API function is selected and parameters are added
2. Build Request
   1. The request is constructed from the function's configuration
3. Send Request
   1. Business Central sends the request to the external system
4. Receive Response
   1. The response comes back into Business Central
5. Process Response
   1. A data buffer is created and mapped

Viewing Messages

• Search for API Messages and select the related link

  • The API Message page includes:

    • General, Processing Timestamps, Related API Messages, Parameters, Request, Response (raw), and Query Request

Running a Message

• Execute runs the full lifecycle at once
• Manual Processing steps through each stage individually (very useful for testing)

Adding Parameters

• Choose Add New Parameter, then select Table Record or Key Value

Message Data Buffers

• The response also appears in structured form as a message data buffer

  • Open it from the Related ribbon's Message Data Buffer action