Connect with our API to automatically import data to a board. Use this feature to import leads, maintenance requests, or any information from your website.
You can access our API documentation here for more details and a QuickStart Guide:
What is an API?
API stands for Application Programming Interface. It’s like a messenger that lets two different apps or systems talk to each other and share information.
Example:
Imagine you’re at a restaurant:
- The menu is the API. It tells you what you can order (what the app can do).
- You (the user) tell the waiter (the API) your order.
- The waiter goes to the kitchen (the server) and gets your food (the data).
- The waiter brings it back to you in a way you can use and understand (like the app getting the data it needs).
In Tech Terms:
An API is how one app (like a weather app) gets data from another system (like a weather service).
- Your request: “Give me today’s weather for New York.”
- The system responds: “Here’s the weather for New York: 72°F and sunny.”
What are Webhooks?
A webhook is like a notification system that automatically sends you information when something happens.
Example:
Imagine you’re waiting for a package:
- You don’t want to keep calling the delivery company every hour to ask, “Is it here yet?” (That’s what APIs often do - polling).
- Instead, you set up notifications so they’ll text you the moment it’s delivered.
That’s exactly what a webhook does! It sends you a message automatically when something changes.
What Data Can I Import with Aptly’s API?
When using Aptly’s API to import data to a board, there are three things that can be accomplished:
- Create a Card
- Create a Contact
- Update Cards
Enabling the API for a Board
The API in Aptly is configured per board, meaning it must be enabled individually on every board where you want to create cards using the API. Once enabled, the API allows external systems to create new cards directly on that board.
How to Enable the API
- Navigate to the board where you want to enable the API.
- Click Integrations in the board menu.
- Select API.
- Toggle the API setting on.
- Once enabled, the board will generate the following details:
- API Key – Used to authenticate requests.
- POST URL – The endpoint used to create cards on the board.
- Update Mode – Determines how updates to existing cards are handled.
- Field Mapping Options – Allows you to map or create fields that incoming API data will populate.
Update Mode | Description |
Always Create New | Creates a new card for each new import |
Update if this field matches | Updates a card if the field selected matches the field that is imported |
These details can then be used to configure integrations that send data to Aptly and automatically create cards on the selected board.
Important Notes
- The API only supports creating cards on a board.
- If you need to send data from Aptly to another system, you should use Webhooks instead.
Webhooks allow you to trigger events in external systems whenever actions occur in Aptly, making them ideal for syncing updates or sending data outside of the platform.
Tip
Because the API is enabled per board, you will need to repeat this process for each board where you want external systems to create cards.
Webhooks
In the table below, you’ll find a list of all of the available Webhooks for the Aptly API along with a brief description of each.
Webhooks - Boards | Purpose | Description |
addCard | Triggered when a new card is added | Sends a notification to inform the receiving service that a card was added to the board. |
getCards | Retrieves a list of cards from Aptly | A 3rd party site will fetch a list of cards from Aptly |
getSchema | Provides the card format and fields | Shares the fields, field types, relationships, required fields. |
Webhooks - Cards | Purpose | Description |
getCard | Send out information for one card | Finds a specific card using the cardId |
postComment | Adds a comment to the card | Lets you or your system add notes to a card under the Comments section |
postFile | Uploads files to a card | Attach files or documents to a card from a 3rd party |
Webhooks - Contacts | Purpose | Description |
getContacts | Send Contact to a 3rd party | Pushes a contact out to a 3rd party |
postContact | Add a contact to Aptly | Syncs a contact from a source |
Webhooks - Users | Purpose | Description |
getUsers | Sends list of Users in your Account | Pushes a list of users from your company account to a 3rd party. |
API Tips & Tricks
Contact mapping: contacts will be added to the default contact field set on the board.
