Send Appium Test Results to Developer Hub

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard
Not for use with personal data

Requires:

  • axe DevTools Mobile Appium Drivers
  • axe DevTools Mobile API Key
  • Developer Hub Project ID

Developer Hub Projects

When you create a project in axe Developer Hub, you will get a unique Project ID that you'll use to push test results to Developer Hub. In addition to this project ID, you will also need an axe DevTools Mobile API Key to send results. Learn how to Get an axe DevTools Mobile API Key.

Setup

  1. Install the axe DevTools Mobile Appium drivers
  2. Use the example below as a reference to implement axe in your tests.
    • Copy/paste your axe DevTools Mobile key into <DEQUE_APIKEY>.
    • Copy/paste the Project ID into <DEVHUB_PROJECT_ID>.

Note: Your results will be posted to both the axe Devtools Mobile Dashboard and axe Developer Hub. The Mobile Dashboard will eventually be retired in favor of axe Developer Hub, but during the transition, you can access your results in both places.

Appium: JavaScript Example

const {remote} = require('webdriverio');

const wdOpts = {
      hostname: process.env.APPIUM_HOST || 'localhost',
  port: parseInt(process.env.APPIUM_PORT, 10) || 4723,
  logLevel: 'info',
  capabilities: {
        // refer to JavaScript examples for WebdriverIO desired capabilities options with UIAutomator2 and XCUITest 
        // https://docs.deque.com/devtools-mobile/2025.7.2/en/appium-example-javascript
  }
}

async function runAccessibilityScan() {
  const driver = await remote(wdOpts);
  try {
    const settings = { apiKey: '<DEQUE_APIKEY>' }
    settings['projectId'] = '<DEVHUB_PROJECT_ID>'
    const result = await driver.execute('mobile: axeScan', settings)
  } finally {
    await driver.pause(1000);
    await driver.deleteSession();
  }
}

runAccessibilityScan().catch(console.error);