Skip to main content

Run ping tests

To test that the endpoint URLs that you entered respond when the platform sends an API call to it, run the AppDirect ping tests. They send dummy events to the URL endpoints to ensure that AppDirect can contact them. The results can be true (success) or false (failed). Ping tests are limited to checking that your endpoint URLs work. Do not use them to check that your endpoints are working within a purchase cycle.

Go to Test integration from Integration Report to check that your endpoints are working within a purchase cycle.

ℹ️ Information:
It is possible to manually test endpoint URL integration. However, we recommend that you Run Ping Tests in the AppDirect user interface.

To run ping tests

  1. Go to Manage > Billing and Distribution > Products > productName | Edit. The product dashboard page opens.

  2. On the left menu, click Integration | Run Ping Tests. The Run Ping Tests page opens. At the left side of each test row, there is a circle to indicate test status. When you have not run a test, it is gray.

  3. Beside the event for the endpoint URL that you want to test, click Run Test. Or, click Run All Tests.

  4. When you run a test, the following occurs:

    1. A new browser window appears.
    2. An asynchronous dummy event request is sent to the notification URL endpoints that you configured on the Edit integration page.
    3. The notification URL endpoint on the vendor (ISV) platform sends a reply to the AppDirect platform.
    4. The reply contains one of the following:
      • 200 OK which indicates True (success)
      • 202 Accepted which indicates True (success)
      • 404 which indicates False (failed) for a non-interactive endpoint
      • 400 which indicates False (failed) for an interactive endpoint
    5. When a test passes, the indicator circle turns green. When a test fails, it turns red.

    For non-interactive endpoints:

    Indicator circle colorStatusDescriptionAction
    GreyNoneNo test was run.
    YellowTest in progressA test is in progress and is not complete.Wait for a response from the vendor platform.
    GreenTest passedThe endpoint is working. An expected error code was received.A response of 200 (OK) or 202 (Accepted) was received from the vendor platform.
    RedTest failedThe endpoint is not working. A 400, 401, 404, 421 or an unexpected error code was received.Correct the endpoint URLs that you entered on the Edit integration page.

    For interactive endpoints:

    📝 Note: We recommend that you do not use interactive endpoints.

    Indicator circle colorStatusDescriptionAction
    GreyNoneNo test was run.
    YellowTest in progressA test is in progress and is not complete.Wait for a response from the vendor platform.
    GreenTest passedTest completed successfully. The endpoint is working.A response of 200 (OK) or 202 (Accepted) was received from the vendor platform.
    RedTest failedThe endpoint is not working.Correct the endpoint URLs that you entered on the Edit integration page.
  5. If a test fails, correct the endpoint URLs on the Edit integration page and run the tests until all URL endpoint tests pass.

Was this page helpful?