Skip to main content

Subscription event notification flow

All subscription event notifications follow the same general flow:

  1. An event is triggered by a customer action (for example when they purchase an application, upgrade a subscription, cancel a subscription, or fail to pay an invoice).
  2. The AppDirect marketplace sends a subscription event notification to the vendor. This event is uniquely identified by an eventUrl.
  3. The vendor must validate the request based on the authorization type configured for their product. See the following topics for more information on how to securely receive event notifications (select the topic based on whether you use separate or shared credentials):
    • Validate outbound event notifications (separate credentials)
    • Validate outbound event notifications (legacy) (shared credentials)
      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 subscription event. Vendors can specify the format of the response they receive from AppDirect.
    • Add Accept: application/json in your HTTP GET request to receive the response from the AppDirect marketplace in JSON format
    • Add Accept: application/xml in your HTTP GET request to receive the response from the AppDirect marketplace in XML format
      If vendors do not specify the content type, an XML payload will be returned.
  4. The AppDirect marketplace sends a JSON or XML response to the vendor.
  5. The vendor then sends a POST request back to the AppDirect marketplace with the account information, status information, or both. The header in the vendor POST request contains a 200 (OK) HTTP code.
  6. The AppDirect marketplace then conveys the status information to the customer through the AppDirect user interface.

Was this page helpful?