Skip to content

Create an API User account

An API User account is used by Sophos Central to communicate with Autotask.

To create an API User account, do as follows:

  1. Sign in to Autotask.
  2. Hover over the Autotask icon and go to Admin > Resources (Users).
  3. In Resources, hover over New and select New API User.
  4. In Add API User, under General, enter details in the required fields.

    1. Enter a username and password that Sophos Central will use to access Autotask.

      Note

      Make a note of these because you will need these later.

    2. Click Active.

  5. Under Security Level, select API User (system).

  6. Under Credentials, click Generate Key.
  7. Under Credentials, click Generate Secret.

    Autotask credentials.

  8. Under API Tracking Identifier, click Integration Vendor. In the box below, select Sophos Central - Security.

  9. Click Save & Close. The account is added to the list of resources.

    Save API user.

Turn on webhooks

When you create an API user account, you must turn on webhooks so the API user can create and manage webhooks.

The key steps are as follows:

  1. Check which security profile is assigned to the API user.
  2. Update the security profile or create a new to turn on webhooks.

Check the security profile

To check which security profile is assigned to the API user, do as follows:

  1. In Autotask, hover over the Autotask icon and go to Admin > Company Settings & Users > Resources/Users (HR) > Resources/Users.
  2. Select the API user you've previously created.
  3. Make note of the assigned Security Levels name.

Update or create a new security profile

To update or create a new security profile to turn on webhooks, do as follows:

  1. In Autotask, hover over the Autotask icon and go to Admin > Company Settings & Users > Resources/Users (HR) > Security > Security Levels.
  2. In Security Levels, find the security profile name you've previously noted.
  3. Click Edit, and then expand the Other section.
  4. Click Webhooks and enter the maximum number of webhooks the API user can create during the account's lifespan. The default value is 50.
  5. Click Save & Close.

Note

You can't edit some of the Autotask Security Levels. If you need to clone and create a new Security Level to turn on Webhooks, you must re-edit the API user and select the Security Level with Webhook access.

Before changing the API user in Sophos for the Autotask integration, make sure the credentials used to manage webhooks remain active. Keeping the credentials active allows the integration to remove the webhooks associated with the previous API user.

When you change the API user for the Autotask integration, this automatically creates a new webhook using the new API user's credentials and will remove the old webhook. If the webhook isn't automatically removed, you must manually remove the webhook created for the previous API user.

To manually remove the old webhook, reactivate the previous API user associated with it, then delete the webhook by calling the Autotask API or contacting Kaseya Support for assistance.

For more information on webhooks, see Webhooks.

After creating an API user account, you must turn on the Sophos Central - Security integration vendor. See Turn on the “Sophos Central - Security” integration vendor.