A Remote System Response is what LeadByte uses to mark an API delivery as successful or otherwise.

Tracking leads as successful or not is important especially if you trigger other linked events such as sending an SMS/Email on Lead Sold, firing a webhook on Lead Sold/Unsold or triggering a linked delivery when a lead has been successfully sent to a remote system.  Furthermore, it is how you record your revenue and ultimately award a payout to a Supplier if you work with partners.

How to map / create a Response

This is done within the Delivery under the section "Remote System Response".  A System Response is bespoke for each system so you should refer to the API guide for the system that you are posting to.  You should expect to know that the success response is for when a lead is accepted and the rejection codes so you can report on them within LeadByte.   

The most important response to capture is the Success Response.  This is what determines of a lead has been successfully transferred / sold.  You should start with this and then establish what the possible reject responses are so you can build your reporting insights.

Example configuration of a Response Handling

In the example below this shows a Delivery that has two Success responses (an HTTP Status and a Keyword of Success).  Additionally, two known responses that are errors (Duplicate and Error).  Only system responses  with the 'Success' checkbox marked will be counted as such.  Anything else will be deemed a failure

Example Response Codes

Successful Responses (this is what is returned by the remote system)

{"outcome":"success","lead":{"id":"6925a96d577c6670dbe7d56e"},"price":0}

{"code":1,"response":"OK","leadId":12345,"payout":"Complete"}

Unsuccessful Responses

{"success":false,"denial_reason":"no-match","message":"No Demand","test":false}

{"outcome":"failure","reason":"Duplicate Email Lead","lead":{"id":"69246b2c3d8b943f5cd89007"},"price":0}

Response Handling Options

Match By: Keyword

In the below example, every delivery response returned which contains the word 'Valid' would be marked as 'Success'

Example responses:

{"code": 0, "response": "valid"}

{"code":1, "response": "invalid"}

Both of the above examples would be marked as success as they contain the word "valid"

Match By: Exact Match

Here, the system would be looking for an exact match on only the word 'Valid' without anything else.

Example responses:

{"code": 0, "response": "valid"}

{"code":1, "response": "invalid"}

Both of the above responses will be marked as unsuccessful as they contain more than just the value "valid".

We would need to use the asterisk symbol to exclude the parts of the response we can ignore

Using the above screenshot, the below examples would be marked as successful:

{"code": 0, "response": "valid"}

{"status": "accepted", "id": "12345", "marked_as": "valid"}

Match By: HTTP Status

In this case, the system would be looking for a specific HTTP code in the response.

Warning - a HTTP Status of 200 does NOT necessarily mean the lead has been marked as successful. ALWAYS check with your buyer/integration guide before setting this as your success response.  Some systems response with a 200 if the request has been received but use the content to confirm if the lead was accepted or rejected.
 

If you wish to store sections of the response to a lead field, the below article is for you - 

https://support.leadbyte.co.uk/hc/en-us/articles/4672396547857-Assign-delivery-response-to-a-lead-field

Responses against Leads

When a lead is rejected you can see the reason why by clicking on the LeadID from the Lead Screen.  You can see the reason why the lead has been rejected in the response box as per the image below.  If you have not mapped the reject response within the Delivery it will not show in your Buyer Rejection Report.
 

As always, please raise a support ticket with any questions.