Events: Errors
Learn about the parameters available in the detailed error log using notifications API.
Some spredfast systems provide detailed error logs:
- error-custom-crm
Payload
Field | Type | Description |
---|---|---|
operation | string Example: searchCustomerById-hydrateCases | The operation being performed within Khoros. |
trackingId | string Example: crm-gateway-eb5e0132-0776-4043-ba7c-a46aee73d7b6 | The Khoros Marketing Tracking ID. Often this ID is presented to users within the Khoros Marketing application and should help in matching errors within the Khoros Marketing UI to those originating from 3rd parties. |
description | string | An explanation of what went wrong. This will not always be available. |
spredfastErrorMessage | string | A more detailed message about the error that occurred within Khoros Marketing such as what went wrong during JSON deserialization. This may not be available on every error. |
externalCall | object |
externalCall Object
Field | Type | Description |
---|---|---|
requestMethod | string | The HTTP method by which the request was made to the third party. |
requestUri | string | The URI being requested. |
requestHeaders | object | Each header is encapsulated in its own value. |
requestQueryParameters | object | Each query parameter is encapsulated in its own value. |
requestBody | string | The body of the request. This property will only be present when one was sent. |
responseHeaders | object | Each header is encapsulated in its own value. |
responseCode | integer Example: 500 | The HTTP code received from the third party. |
requestHeaders Object
Field | Type | Description |
---|---|---|
someHeaderName | array[string] | The name of a header sent to the third party as part of the request. |
requestQueryParameters Object
Field | Type | Description |
---|---|---|
someQueryParameter | array[string] | The value of a single query parameter sent to the third party. |
responseHeaders Object
Field | Type | Description |
---|---|---|
someHeaderName | array[string] | The value of a single header received from the third party. |
Example Body
{
"companyId":12345,
"eventName":"error-custom-crm",
"createdDate":"Thu Sep 13 09:08:15 CDT 2018",
"eventUuid":"ae064a0d-dc4b-4731-ad4c-ceecf5babcde",
"type":"hydrated",
"data":{
"operation":"searchCustomerById-hydrateCases",
"trackingId":"crm-gateway-eb5e0132-0776-4043-ba7c-a46aee7abcde",
"description":"Could not find resource",
"externalCall":{
"requestUri":"http://3rd.party.com/api/v1/customer/1234/cases",
"requestHeaders":{
"x-sf-company-id":[
"1234"
],
"x-sf-user-email":[
"[email protected]"
],
"x-sf-initiative":[
"1234"
]
},
"requestMethod":"GET",
"responseHeaders":{
"Transfer-Encoding":[
"chunked"
],
"Connection":[
"keep-alive"
],
"content-type":[
"application/json"
],
"Date":[
"Thu, 13 Sep 2018 14:08:14 GMT"
]
},
"requestBody":"",
"responseCode":404
}
},
"subscriptionUuid":"f89f99ce-f432-430b-b3fd-8f02d581abcd"
}
Updated almost 3 years ago