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. Note -
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
How to Import Data to a Board with Aptly's API
To import data to a single board, head to the intended board to set up the API integration.
- From the board, click on Card Sources in the Board Settings menu on the left.
- Click on API (it’s the first one in the list).
- Toggle the API ON. It will appear green and an API Key will automatically be generated under Your API Key.
- Copy the custom API Key made especially for the board and integrate it with your website or wherever you wish to integrate. You might need to contact your IT department or system administrator for help.
- Leave the Post URL as it is. Each board has its own dedicated Post URL.
- Select an Update Mode.
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 |
- If the field does not exist, you can select to have the API create the field based on the source data.
- Webhook URL is a specific action that you want the integration to complete. A list of our available webhooks can be found in our Aptly API Documentation.
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. |
Related Articles
- Navigate Aptly