fiatjaf / trello-webhooks

What data comes in when you get a Trello webhook.

All webhooks come with the following structure:

{
    "model": {
        "id": "597f3c854baa6e43db4f07d7",
        "name": "testing",
        "desc": "",
        "descData": null,
        "closed": false,
        "idOrganization": "597f2c1a80a903bf442c826e",
        "pinned": false,
        "url": "https://trello.com/b/CGKHU6vL/testing",
        "shortUrl": "https://trello.com/b/CGKHU6vL",
        "prefs": {
            "permissionLevel": "org",
            "voting": "disabled",
            "comments": "org",
            "invitations": "members",
            "selfJoin": true,
            "cardCovers": true,
            "cardAging": "regular",
            "calendarFeedEnabled": false,
            "background": "green",
            "backgroundImage": null,
            "backgroundImageScaled": null,
            "backgroundTile": false,
            "backgroundBrightness": "dark",
            "backgroundBottomColor": "#519839",
            "backgroundTopColor": "#519839",
            "backgroundColor": "#519839",
            "canBePublic": true,
            "canBeOrg": true,
            "canBePrivate": true,
            "canInvite": true
        },
        "labelNames": {
            "green": "",
            "yellow": "",
            "orange": "",
            "red": "",
            "purple": "",
            "blue": "",
            "sky": "",
            "lime": "",
            "pink": "",
            "black": ""
        }
    },
    "action": {
        "id": "59bc8e2ddbd7af0e1474fb0e",
        "idMemberCreator": "50e853a3a98492ed05002257",
        "data": {
            "checklistSource": {
                "name": "7777777777777",
                "id": "59bc8e1b5135cbe9718deb2d"
            },
            "board": {
                "shortLink": "CGKHU6vL",
                "name": "testing",
                "id": "597f3c854baa6e43db4f07d7"
            },
            "checklist": {
                "name": "7777777777777",
                "id": "59bc8e2ddbd7af0e1474fb08"
            }
        },
        "type": "copyChecklist",
        "date": "2017-09-16T02:36:29.244Z",
        "memberCreator": {
            "id": "50e853a3a98492ed05002257",
            "avatarHash": "d2f9f8c8995019e2d3fda00f45d939b8",
            "fullName": "Alfred M",
            "initials": "FJ",
            "username": "alfmx"
        },
        "display": {
            "translationKey": "unknown",
            "entities": {
                "memberCreator": {
                    "type": "member",
                    "id": "50e853a3a98492ed05002257",
                    "username": "alfmx",
                    "text": "Alfred M"
                }
            }
        }
    }
}

model is the model being observed. action is different depending on the event type. Each type of event has its structure in one file in this repository.

Current types of Trello's events

Sorted by alphabetic name

• addAttachmentToCard
• addChecklistToCard
• addLabelToCard
• addLabelToCard
• addMemberToBoard
• addMemberToCard
• commentCard
• convertToCardFromCheckItem
• copyCard
• copyChecklist
• createCard
• createCheckItem
• createLabel
• createList
• deleteAttachmentFromCard
• deleteCard
• deleteCheckItem
• deleteComment
• deleteLabel
• emailCard
• moveCardFromBoard
• moveCardToBoard
• moveListFromBoard
• moveListToBoard
• removeChecklistFromCard
• removeLabelFromCard
• removeMemberFromBoard
• removeMemberFromCard
• updateBoard
• updateCard
• updateCheckItem
• updateCheckItemStateOnCard
• updateChecklist
• updateComment
• updateCustomFieldItem
• updateLabel
• updateList

trello-webhooks's Issues

Fine-grained action types

Just a suggestion:

There's a translationKey property under the display property in each action.

It is some sort of sub type for the action like if the action type is updateBoard and the translationKey is action_update_board_name it means the board name was changed.

From this you'll know what action happened exactly. The translationKey is not documented anywhere in the Trello docs., so I'm not sure how reliable it is.

PR guidelines?

Hey there,

Some of the outputs have changed. I was thinking of sending you a PR, but should I just send you the raw output, or do anything, like changing the ids?

Missing webhook data

Hey,

really great repo, helped a lot

For
https://github.com/fiatjaf/trello-webhooks/blob/master/checkitem-move-between-checklists
https://github.com/fiatjaf/trello-webhooks/blob/master/checkitem-move

trello now returns a response. Would be great if you could update your repo.