Set up and test with Insomnia

You can start with the free version of Insomnia. This gives you basic features that cover most testing requirements. If you need more features, you can always upgrade later on.

Insomnia lets you keep collections of sample GraphQL queries you can use over and over for testing. It also uses OAuth syntax and lets you use variables to update things like access tokens.

Tip: You can also follow the install guide from Insomnia.

Step 1: Set up your app in the Intuit Developer Portal

If you haven’t already, get a QuickBooks Online sandbox company for testing, create your app, and get your sandbox company’s Client ID and Client Secret.

Step 2: Add the Insomnia redirect URI

1. Sign in to your developer account.
2. Select the Dashboard link on the toolbar.
3. Select and open your app.
4. In the Development section, select Keys & OAuth.
5. In the Redirect URIs section, select Add URI.
6. Enter the insomnia redirect URI: https://insomnia.rest.

Step 3: Download and set up Insomnia

1. Download the latest version of Insomnia.
2. Launch and install Insomnia.
3. Select the Manage environments option.
4. Paste this configuration into the window:

{
"AccessTokenUrl": "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer",
"Authurl": "https://appcenter.intuit.com/connect/oauth2",
"ClientId": "[Your app's ClientID]",
"ClientSecret": "[Your app's ClientSecret]",
"RedirectUrl": "https://insomnia.rest",
"url": "https://public.api.intuit.com/2020-04/graphql"
}

This configures and connects Insomnia to your app and Intuit Ecosystem API.

Step 4: Start a test query in Insomnia

1. Select the (+) icon and then New Request.
2. Name the request.
3. Select the POST method from the dropdown.
4. Select the URL environment variable. You set up the environment in Step 2.
5. Select GraphQL query as the query type.
6. Select Create.

This opens a query window. Use this basic test query to get company data for your sandbox test company:

query company {
  company {
    id
    legalName
    industryType	
  }
}

Step 5: Configure authorization variables Insomnia

In the query window, set the OAuth2.0 environment variables:

1. Select the OAuth 2.0 tab.
2. From the Grant type dropdown, select Authorization code.
3. In the Authorization URL field, enter Authurl.
4. In the Access Token URL field, enter AccessTokenUrl.
5. In the Client ID field, enter ClientId.
6. In the Client Secret field, enter ClientSecret.
7. In the Redirect URL field, enter RedirectUrl.
8. Select the Enabled checkbox.

Step 6: Send the test query

Everything is ready to go. Select Send to send the test query.

The first time you send a query, Insomnia will ask you to sign in to your sandbox QuickBooks Online company. Follow the on-screen steps to connect them.

You’ll see access tokens in the OAuth 2.0 tab. Use these to test code and queries in Insomnia.