Configure Endpoints

Summary: To receive subscription order and cancellation events, and to support end-user authentication, you need to set endpoint URLs for your app.

To configure endpoint URLs for your app, follow these instructions:

  1. Sign in to your Partner account on the ADP Marketplace website if you have not already done so.
  2. On the Marketplace main page, select Developer > Products and then click Edit for your product.

    pubAppEcomm-Step3.png

  3. On the left side of the dashboard, under Integration, select Edit Integration.
  4. Configure each integration setting URL with the options described in the table. These URLs must be accessible through the internet and contain the {eventUrl} placeholder. This placeholder will be replaced by the URL of the order event at runtime. For example: https://example.com/appdirect/notify.php?url={eventUrl}

    Note: Data Connector applications support the Subscription Create Notification and Subscription Cancel Notification events only.




  5. Subscriptions Options
    Subscription Create Notification URL
    • ADP will call this URL when users purchase new subscriptions.
    • This URL can either be non-interactive (default and recommended behavior) or interactive.
    • This URL must contain the {eventUrl} placeholder which will be replaced by the URL of the order event at runtime.
    • Optional – To configure additional product settings at checkout, select “Additional product settings required during checkout.”The Additional Settings form will also be displayed.
    Subscription Change Notification URL
    • ADP will call this URL when users upgrade/downgrade subscriptions.
    • This URL can only be non-interactive.
    • This URL must contain the {eventUrl} placeholder which will be replaced by the URL of the order event at runtime.
    • Optional – To configure additional product settings at checkout, select “Additional product settings required during checkout.”
      The Additional Settings form will also be displayed.
    Subscription Cancel Notification URL
    • ADP will call this URL when users cancel subscriptions
    • This URL can only be non-interactive.
    • This URL must contain the {eventUrl} placeholder, which will be replaced by the URL of the order event at runtime.
    Subscription Status Notification URL
    • ADP will call this URL when a subscription status changes.
    • For example, when a subscription becomes suspended after a free trial expires or gets automatically cancelled sometime after an invoice is overdue.
    • This URL can only be non-interactive.
    • This URL must contain the {eventUrl} placeholder, which will be replaced by the URL of the order event at runtime.


    pubAppEcomm-Step3b.png

  6. To verify that your endpoints are valid, select Integration Report in the dashboard menu.
    Click the Test Integration button and verify that the status button for each event is green. Address any issues and repeat as needed.

    pubAppEcomm-Step3c.png