Trello integration summary

Stitch’s Trello integration replicates data using the Trello REST API. Refer to the Schema section for a list of objects available for replication.

Trello feature snapshot

A high-level look at Stitch's Trello (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Beta

Supported by

Stitch

Stitch plan

Free

API availability

Available

Singer GitHub repository

singer-io/tap-trello

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Supported

Table-level reset

Unsupported

Configurable Replication Methods

Unsupported

DATA SELECTION
Table selection

Supported

Column selection

Supported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting Trello

Trello setup requirements

To set up Trello in Stitch, you need:

  • To be a member of every Trello board you want to replicate. If a board is private and the user isn’t a member, Stitch will be unable to access it. Before beginning the setup process, verify that the user setting up the integration has access to all the boards you want to replicate.

    Refer to the Replication section for why this is required.

Step 1: Add Trello as a Stitch data source

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Trello icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Trello” would create a schema called stitch_trello in the destination. Note: Schema names cannot be changed after you save the integration.

Step 2: Define the historical sync

The Sync Historical Data setting will define the starting date for your Trello integration. This means that:

  • For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your data warehouse.
  • For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Trello’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 3: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Trello integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 4: Authorize Stitch to access Trello

  1. Next, you’ll be redirected to Trello.
  2. Log into your Trello account and complete the authorization process. When finished, you’ll be redirected back to Stitch.
  3. Click All Done.

Step 5: Set tables and columns to replicate

To complete the setup, you’ll need to select the tables and columns you want to replicate to your data warehouse.

Check out the Schema section to learn more about the available tables in Trello and how they replicate.

  1. In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A green checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.

Initial and historical replication jobs

After you finish setting up Trello, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.


Trello replication

In this section:

Data replication via board membership

Stitch’s Trello integration replicates data by first querying for the boards that the user authorizing the integration in Stitch is a member of. Specifically, Stitch uses the Get boards that member belongs to endpoint (/1/members/{id}/boards) to retrieve the boards the user is a member of.

This means that to replicate data successfully, including boards, the user who authorized the integration in Stitch must be a member of every board you want to replicate data from.

Let’s take a look at what Extraction might look like for boards and cards using some SQL queries.

  1. Stitch queries for boards that the authorizing user is a member of. In this example, the authorizing user’s ID is 559be34bc1f1b3f3383671b7:

    SELECT id as user_id,
           idBoard
      FROM members
     WHERE id = '559be34bc1f1b3f3383671b7'
    

    Which returns the following:

    | id                       | idBoard                  |
    |--------------------------+--------------------------|
    | 559be34bc1f1b3f3383671b7 | 574f5d5202564aa4447e14a5 |
    
  2. Stitch queries for cards using the idBoard value returned in the first query:

    SELECT id as card_id,
           idBoard,
           <other card fields>
      FROM cards
     WHERE idBoard = '574f5d5202564aa4447e14a5'
    

    Which returns the following:

    | card_id                  | boardId                  |
    |--------------------------+--------------------------|
    | 5c26a3ce766676349d2f82d2 | 574f5d5202564aa4447e14a5 |
    | 5c2e83a628ffe90351d0208b | 574f5d5202564aa4447e14a5 |
    | 5c950cf7e1ad9b845171680b | 574f5d5202564aa4447e14a5 |
    

This approach is used for every table set to replicate. If you’re missing data, verify that the authorizing user is a member of the board.

Custom field support

Custom fields are supported for the following tables:


Trello table schemas

Replication Method :

Key-based Incremental

Replication Key :

date

Primary Key :

id

API endpoint :

Get actions of a board

The actions table contains information about the actions within each board the authorizing user is a member of.

id
STRING

The action ID.

Reference:

date
STRING

The date the action was created.

data
OBJECT

board
OBJECT

id
STRING

The board ID.

Reference:

name
STRING

prefs
OBJECT

background
STRING

actions (table), prefs (attribute)

shortLink
STRING

actions (table), board (attribute)

card
OBJECT

cardSource
OBJECT

id
STRING

idShort
INTEGER

name
STRING

shortLink
STRING

actions (table), cardSource (attribute)

deactivated
BOOLEAN

idMember
STRING

Reference:

idMemberAdded
STRING

Reference:

idMemberInviter
STRING

Reference:

list
OBJECT

closed
BOOLEAN

id
STRING

Reference:

name
STRING

pos
NUMBER

actions (table), list (attribute)

listAfter
OBJECT

actions (table), listAfter (attribute)

listBefore
OBJECT

actions (table), listBefore (attribute)

member
OBJECT

memberType
STRING

method
STRING

old
OBJECT

closed
BOOLEAN

desc
STRING

idList
STRING

Reference:

idMembers
ARRAY

name
STRING

pos
NUMBER

prefs
OBJECT

background
STRING

actions (table), prefs (attribute)
actions (table), old (attribute)

organization
OBJECT

actions (table), organization (attribute)

text
STRING

actions (table), data (attribute)

idMemberCreator
STRING

Reference:

limits
OBJECT

reactions
OBJECT

perAction
OBJECT

disableAt
INTEGER

status
STRING

warnAt
INTEGER

actions (table), perAction (attribute)

uniquePerAction
OBJECT

disableAt
INTEGER

status
STRING

warnAt
INTEGER

actions (table), uniquePerAction (attribute)
actions (table), reactions (attribute)
actions (table), limits (attribute)

member
OBJECT

activityBlocked
BOOLEAN

avatarHash
STRING

avatarUrl
STRING

fullName
STRING

id
STRING

Reference:

idMemberReferrer
STRING

initials
STRING

nonPublicAvailable
BOOLEAN

username
STRING

actions (table), member (attribute)

memberCreator
OBJECT

type
STRING


Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get boards that a member belongs to

The boards table contains info about the boards that the authorizing user is a member of.

Custom field support

Custom fields are supported for this table.

id
STRING

The board ID.

Reference:

closed
BOOLEAN

creationMethod
STRING

dateLastActivity
DATE-TIME

The date the board last had activity on it.

dateLastView
DATE-TIME

datePluginDisable
DATE-TIME

desc
STRING

descData
STRING

enterpriseOwned
BOOLEAN

idBoardSource
STRING

idEnterprise
STRING

idOrganization
STRING

idTags
ARRAY

value
STRING

Reference:

boards (table), idTags (attribute)

ixUpdate
INTEGER

labelNames
OBJECT

black
STRING

blue
STRING

green
STRING

lime
STRING

orange
STRING

pink
STRING

purple
STRING

red
STRING

sky
STRING

yellow
STRING

boards (table), labelNames (attribute)

limits
OBJECT

attachments
OBJECT

perBoard
OBJECT

disableAt
INTEGER

status
STRING

warnAt
INTEGER

boards (table), perBoard (attribute)
boards (table), attachments (attribute)
boards (table), limits (attribute)

memberships
ARRAY

name
STRING

pinned
BOOLEAN

powerUps
ARRAY

value
STRING

boards (table), powerUps (attribute)

prefs
OBJECT

background
STRING

backgroundBottomColor
STRING

backgroundBrightness
STRING

backgroundImage
STRING

backgroundImageScaled
ARRAY

height
INTEGER

url
STRING

width
INTEGER

boards (table), backgroundImageScaled (attribute)

backgroundTile
BOOLEAN

backgroundTopColor
STRING

calendarFeedEnabled
BOOLEAN

canBeEnterprise
BOOLEAN

canBeOrg
BOOLEAN

canBePrivate
BOOLEAN

canBePublic
BOOLEAN

canInvite
BOOLEAN

cardAging
STRING

cardCovers
BOOLEAN

comments
STRING

hideVotes
BOOLEAN

invitations
STRING

isTemplate
BOOLEAN

permissionLevel
STRING

selfJoin
BOOLEAN

voting
STRING

boards (table), prefs (attribute)

premiumFeatures
ARRAY

value
STRING

boards (table), premiumFeatures (attribute)

shortLink
STRING

shortUrl
STRING

starred
BOOLEAN

subscribed
BOOLEAN

templateGallery
STRING

url
STRING


Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get filtered cards on a board

The cards table contains info about all of the cards on boards that authorizing user is a member of.

Custom field support

Custom fields are supported for this table.

id
STRING

The card ID.

Reference:

badges
OBJECT

attachments
INTEGER

attachmentsByType
OBJECT

trello
OBJECT

board
INTEGER

card
INTEGER

cards (table), trello (attribute)
cards (table), attachmentsByType (attribute)

checkItems
INTEGER

checkItemsChecked
INTEGER

checkItemsEarliestDue
DATE-TIME

comments
INTEGER

description
BOOLEAN

due
DATE-TIME

dueComplete
BOOLEAN

fogbugz
STRING

location
BOOLEAN

subscribed
BOOLEAN

viewingMemberVoted
BOOLEAN

votes
INTEGER

cards (table), badges (attribute)

checkItemStates
ARRAY

value
ANYTHING

cards (table), checkItemStates (attribute)

closed
BOOLEAN

cover
OBJECT

brightness
STRING

color
STRING

idAttachment
STRING

idUploadedBackground
BOOLEAN

size
STRING

cards (table), cover (attribute)

customFieldItems
ARRAY

id
STRING

idCustomField
STRING

idModel
STRING

idValue
STRING

modelType
STRING

value
OBJECT

checked
STRING

date
STRING

number
STRING

option
STRING

text
STRING

cards (table), value (attribute)
cards (table), customFieldItems (attribute)

dateLastActivity
DATE-TIME

The date the card last had activity on it.

desc
STRING

descData
OBJECT

emoji
OBJECT

cards (table), descData (attribute)

due
DATE-TIME

dueComplete
BOOLEAN

dueReminder
STRING

idAttachmentCover
STRING

idBoard
STRING

Reference:

idChecklists
ARRAY

idLabels
ARRAY

value
STRING

cards (table), idLabels (attribute)

idList
STRING

Reference:

idMembers
ARRAY

idMembersVoted
ARRAY

idShort
INTEGER

isTemplate
BOOLEAN

labels
ARRAY

cards (table), labels (attribute)

manualCoverAttachment
BOOLEAN

name
STRING

pos
NUMBER

shortLink
STRING

shortUrl
STRING

subscribed
BOOLEAN

url
STRING


Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get checklists on a board

The checklists table contains info about checklists on boards that the authorizing user is a member of.

id
STRING

The checklist ID.

Reference:

badges
OBJECT

attachments
INTEGER

attachmentsByType
OBJECT

trello
OBJECT

board
INTEGER

card
INTEGER

checklists (table), trello (attribute)
checklists (table), attachmentsByType (attribute)

checkItems
INTEGER

checkItemsChecked
INTEGER

checkItemsEarliestDue
STRING

comments
INTEGER

description
BOOLEAN

due
STRING

dueComplete
BOOLEAN

fogbugz
STRING

location
BOOLEAN

subscribed
BOOLEAN

viewingMemberVoted
BOOLEAN

votes
INTEGER

checklists (table), badges (attribute)

checkItemStates
STRING

checkItems
ARRAY

closed
BOOLEAN

cover
OBJECT

brightness
STRING

color
STRING

idAttachment
STRING

idUploadedBackground
STRING

size
STRING

checklists (table), cover (attribute)

creationMethod
STRING

data
OBJECT

board
OBJECT

id
STRING

The board ID.

Reference:

name
STRING

prefs
OBJECT

permissionLevel
STRING

selfJoin
BOOLEAN

checklists (table), prefs (attribute)

shortLink
STRING

checklists (table), board (attribute)

card
OBJECT

closed
BOOLEAN

due
STRING

dueComplete
BOOLEAN

id
STRING

The card ID.

Reference:

idShort
INTEGER

name
STRING

shortLink
STRING

checklists (table), card (attribute)

checklist
OBJECT

id
STRING

Reference:

name
STRING

checklists (table), checklist (attribute)

creationMethod
STRING

list
OBJECT

old
OBJECT

closed
BOOLEAN

due
STRING

dueComplete
BOOLEAN

name
STRING

prefs
OBJECT

permissionLevel
STRING

selfJoin
BOOLEAN

checklists (table), prefs (attribute)
checklists (table), old (attribute)

organization
OBJECT

id
STRING

Reference:

name
STRING

checklists (table), organization (attribute)
checklists (table), data (attribute)

date
STRING

dateLastActivity
STRING

The date the checklist last had activity on it.

dateLastView
STRING

datePluginDisable
STRING

desc
STRING

descData
STRING

due
STRING

dueComplete
BOOLEAN

dueReminder
STRING

enterpriseOwned
BOOLEAN

fullName
STRING

idAttachmentCover
STRING

idBoard
STRING

Reference:

idBoardSource
STRING

idCard
STRING

Reference:

idChecklists
ARRAY

value
STRING

checklists (table), idChecklists (attribute)

idEnterprise
STRING

idList
STRING

Reference:

idMemberCreator
STRING

Reference:

idOrganization
STRING

Reference:

idShort
INTEGER

isTemplate
BOOLEAN

ixUpdate
STRING

labelNames
OBJECT

black
STRING

blue
STRING

green
STRING

lime
STRING

orange
STRING

pink
STRING

purple
STRING

red
STRING

sky
STRING

yellow
STRING

checklists (table), labelNames (attribute)

limits
OBJECT

checkItems
OBJECT

perChecklist
OBJECT

disableAt
INTEGER

status
STRING

warnAt
INTEGER

checklists (table), perChecklist (attribute)
checklists (table), checkItems (attribute)
checklists (table), limits (attribute)

manualCoverAttachment
BOOLEAN

memberCreator
OBJECT

memberships
ARRAY

name
STRING

pinned
STRING

pos
NUMBER

prefs
OBJECT

background
STRING

backgroundBottomColor
STRING

backgroundBrightness
STRING

backgroundColor
STRING

backgroundImage
STRING

backgroundImageScaled
ARRAY

height
INTEGER

url
STRING

width
INTEGER

checklists (table), backgroundImageScaled (attribute)

backgroundTile
BOOLEAN

backgroundTopColor
STRING

calendarFeedEnabled
BOOLEAN

canBeEnterprise
BOOLEAN

canBeOrg
BOOLEAN

canBePrivate
BOOLEAN

canBePublic
BOOLEAN

canInvite
BOOLEAN

cardAging
STRING

cardCovers
BOOLEAN

comments
STRING

hideVotes
BOOLEAN

invitations
STRING

isTemplate
BOOLEAN

permissionLevel
STRING

selfJoin
BOOLEAN

voting
STRING

checklists (table), prefs (attribute)

shortLink
STRING

shortUrl
STRING

softLimit
STRING

starred
BOOLEAN

subscribed
BOOLEAN

templateGallery
STRING

type
STRING

url
STRING

username
STRING


Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get lists on a board

The lists table contains info about lists on boards that the authorizing user is a member of.

Note: To replicate this table, the boards table must be set to replicate.


Replication Method :

Full Table

Primary Key :

id : boardId

API endpoint :

Get the members of a board

The users table contains information about users who are members of boards that the authorizing user is also a member of.



Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.