Getting Started with the DoubleTick Developer API

Integrate third-party apps with DoubleTick using our Developer API. Access API documentation and API keys for seamless integration and enhanced workflow efficiency.

If you work with a development team or use business software like a CRM or ERP, DoubleTick's Developer API section gives you everything you need to connect your account with those external systems. This article walks you through what the Developer API is, how to find your API key, and how to use it safely.

What Is the Developer API?

The Developer API is a section within your DoubleTick settings that provides two things: an API key, which acts as your account's access credential, and a link to the API documentation, which your developers will refer to when building integrations. Think of it as a control panel for technical connections between DoubleTick and any external platform.

How to Access It

To get started, go to the Settings section on your DoubleTick dashboard and click on Developer API. This is where you will find your API key and all related options.

Understanding Your API Key

Your API key is a unique code that authorises external systems to communicate with your DoubleTick account. When a developer connects DoubleTick to another platform, they use this key to verify the connection. Because it grants access to your entire account, it is important to treat it like a password and share it only with people you trust, such as your in-house developers or verified integration partners.

A few things to keep in mind regarding safe usage: never paste your API key into a public code repository, a shared document, or any platform that is not secured. If you ever suspect that the key has been exposed or misused, regenerate it immediately.

Note: The API key length has been increased to up to 300 characters. This is a platform-level update and does not affect any of your existing integrations.

What You Can Do with the API Key

Within the Developer API section, you will find three options for managing your key.

Copy Key lets you copy the API key to your clipboard so you can share it or store it immediately. Share Key allows you to send the key directly to your developers or integration partners via WhatsApp. Regenerate Key creates a brand new key when needed, for instance if your current key has been compromised or you are onboarding a new team.

How to Regenerate Your API Key

If you need to generate a new API key, click on Regenerate Key. A confirmation prompt will appear, letting you know that any existing integrations using the current key may be affected. Click Regenerate to confirm.

Once the new key is generated, the old key becomes permanently invalid. Any integration, automation, or connected system that was using the previous key will stop working until it is updated with the new one. Before regenerating, make sure your development team is aware and ready to update all active connections.

Accessing the API Documentation

Next to the API key options, you will find an Open Link button that takes you to the full API documentation. This is the primary reference your developers will use when building or troubleshooting integrations. The documentation covers DoubleTick's public APIs, webhook configurations, and a range of functional modules including templates, broadcasts, wallets, teams, roles, and more. Each module is documented with the specific capabilities it supports.

Summary

To summarise, the Developer API section gives you the tools you need to connect DoubleTick with your existing business systems. Your API key is the credential that makes these connections possible, so keep it secure and update all integrations promptly if you ever regenerate it. Use the API documentation to guide your development team through the setup, and you will have a reliable, automated workflow up and running in no time.