API Logging

EngageIP logs all API requests as well as the responses.

JSON API Log

The JSON API log will contain the header and body for all requests and responses. This log can aid you while developing by providing details of both good and bad requests. Navigate to Operations > Logs. Each request is listed in chronological order.

Request

The request tab allows you to view the request body and header. The request body and header details of a good request made from the UI can be used as a guide for developing your own integrations. For example, an order entry integration would need to make use of the same APIs for creating an account, adding a contact, and products to the account. By first completing each operation the UI, a developer can then view the associated log entries for a well-formed request.

Response

The response tab allows your to view the request body and header. As a developer you will strive for successful requests. However, error responses can guide you in this process. Here is an example of a successful patch response:

Bad Request Error Messages

EngageIP's response to bad requests includes all errors not just the first error found. The form of the error object is below:

Error
code
"code": 10400000
Type: Number
An internal error code
message
"message": "'Name' validation requires the additional constraint property value 'StateId' to be included in the payload and greater than zero."
Type: String
The human-readable form of the error.

A sample of errors in the response: