> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# autify/web

Runs a test plan to run automated E2E test scenarios on Autify For Web. Make sure to set your personal access token in the environment variable `AUTIFY_FOR_WEB_API_TOKEN` in your project. Click `Settings` on the left menu in https://app.autify.com/ and you can get the token in the `Generate Personal Access Token` section.


## Commands

### run_test_plan

Runs a test plan on Autify For Web.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `response_file_path` | string | response-web-run-test-plan.txt | File path that keeps the response from the API |
| `test_plan_api_base_url` | string | https://app.autify.com/api/v1/schedules/ | API endpoint URL |
| `test_plan_id` | string |  | Test Plan ID that you want to run |

## Examples

### run_test_plan

Runs a test plan on Autify For Web.


```yaml
version: '2.1'
orbs:
  autify-web: autify/web@1.2.3
workflows:
  use-my-orb:
    jobs:
      - autify-web/run_test_plan:
          test_plan_id: '12345'
```