> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Ghost Inspector Plugin

View this plugin on the Plugins site

ghostInspector: Run Ghost Inspector Test Suite

  • apiKey
    Enter your Ghost Inspector API key. This is a unique, private key provided with your account which allows you to access the API. You can find it in your Account Settings in the Ghost Inspector application.
    • Type: String
  • suiteId
    Enter the ID of the Ghost Inpsector suite that you would like to execute.
    • Type: String
  • startUrl
    (Optional) Enter a custom URL to run the test suite on. If you're running your tests on the local build of your application, you may wish to create an local tunnel and use that URL here.
    • Type: String
  • params
    (Optional) Additional parameters to pass to the API in the form of "viewport=1024x768&customVar=foo". You may wish to override the screen size or include custom variables.
    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.