Notification URLs and responses

Vendors must validate the request based on the authorization type configured for their product. See Configure product integration security for more detail on how to securely receive event notifications. After validation is complete, the vendor can read the eventUrl from the parameters and send an HTTP GET request for more information about the specific system event.

Vendors can specify the format of the response they receive from AppDirect. They can add Accept: application/json in their HTTP GET request to receive the response from AppDirect in JSON format. They can add Accept: application/xml in their HTTP GET request to receive the response from AppDirect in XML format. If vendors do not specify the content type, an XML payload will be returned.

The vendor can then process the event on their side (account creation, account updates, account cancellations, and so on). After the event is processed, the vendor must respond to the call they received in JSON or XML format with the result of the operation. If an error occurred while processing the event, they should not return a 500 or 404 status. The vendor should return a 200 status with a properly formatted JSON or XML as described below.

Success response to a notification

JSON

{
    "success": "true",
    "accountIdentifier": "new-account-identifier"
}

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<result>
	<success>true</success>
	<accountidentifier>new-account-identifier</accountidentifier>
</result>

AppDirect only requires an accountIdentifier in the response to a Subscription Order Event so we know how to reference the new customer account in future event notifications.

Error response to a notification

JSON

{
	"success": "false",
	"errorCode": "ACCOUNT_NOT_FOUND",
	"message": "The account TEST123 could not be found."
}

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<result>
	<success>false</success>
	<errorcode>ACCOUNT_NOT_FOUND</errorcode>
	<message>The account TEST123 could not be found.</message>
<result>