Back to Integrations Guides

API Integrations

Introduction

The API Integration feature allows you to connect AAArdvark with third-party applications and services. In this guide, we’ll walk you through how to create an API key to add it to an external application, making it easy for AAArdvark to integrate with your existing workflows.

Configuring API Integration

In your AAArdvark Workspace, select the site you’d like to configure from the left sidebar menu. Then, click Integrations to begin setting up your API key.

The site menu in the left sidebar, with Integrations selected at the bottom.
Select the Integrations option under site options

Once the Integrations screen opens next to the sidebar, select Add Integration.

The Integrations page for a site, with the Add Integration link highlighted.
Select the ‘Add Integration’ option

On the next screen, you’ll see the API Integration option at the bottom. Click Add API Integration to proceed.

The Add Integration list, with the Add API Integration link on the API Integration card at the bottom highlighted.
Choose “Add API Integration” from the module

Then, on the next step, ensure the Enable Integration toggle is enabled and click Add to generate the API key.

The Add API Integration form with the Enable Integration toggle turned on and the Add button.
Add API Integration to generate the key

Your API key will be generated and ready to copy. After copying it from your AAArdvark workspace and pasting it into your third-party service, click Continue.

Note: Your API key is only shown once. After you click Continue, you won’t be able to see it again, so copy it and keep it somewhere safe before moving on. If you lose it, you can regenerate a new key.

The API key pop-up, with the Copy to Clipboard link and the Continue button highlighted.
Copy the generated API key

You’ll then see a confirmation that the API integration is enabled and ready to use.

The Integrations page listing API Integration with an Enabled badge and a Configure button.
API Integration enabled

Regenerating Your API Key

If you lost your key or need to replace it, you can generate a new one at any time.

  1. Select your site from the left sidebar menu and click Integrations.
  2. Next to API Integration, click Configure (the gear icon).
  3. Click Regenerate Key, then copy the new key from the pop-up before clicking Continue.
The Update API Integration screen, with the Regenerate Key button highlighted in the API Token section.
Click Regenerate Key to replace your API key

Regenerating a key immediately stops the old key from working. Update any third-party service that uses it with the new key.

API Key Not Working or Integration Failed

If your third-party service can’t connect, start with the basics:

  • Check the key was copied in full, with no extra spaces or line breaks.
  • Make sure the Enable Integration toggle is still on. Disabling it stops the key from working immediately.
  • If the key was regenerated since you first copied it, the old value stops working right away. Update your third-party service with the new key, or regenerate a new one if you don’t have it.

Still stuck? Reach out to support.

Still stuck?

File a support ticket with our five-star support team to get more help.

File a ticket

  • This field is for validation purposes and should be left unchanged.
  • Please provide any information that will be helpful in helping you get your issue fixed. What have you tried already? What results did you expect? What did you get instead?

Related Guides