Event Types & Payloads



Board

Webhook Header

x-gk-event: boards


archived

Triggered when the board is archived.

Events API payload

Key Type Description
action string The string archived.
board object The board the action occurred in.
sender object The user that triggered the event.

Webhook payload example

{
  "action": "archived",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Welcome Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "sequence": 11
}


unarchived

Triggered when the board is unarchived.

Events API payload

Key Type Description
action string The string unarchived.
board object The board the action occurred in.
sender object The user that triggered the event.

Webhook payload example

{
  "action": "unarchived",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Welcome Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "sequence": 12
}


updated

Triggered when the board is renamed.

Events API payload

Key Type Description
action string The string updated.
board object The board the action occurred in.
sender object The user that triggered the event.

Webhook payload example

{
  "action": "updated",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board",
    "previous": {
      "id": "5bf41c0a6567c2000e91a792",
      "name": "Welcome Board"
    }
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "sequence": 13
}


deleted

Triggered when the board is deleted.

Events API payload

Key Type Description
action string The string deleted.
board object The board the action occurred in.
sender object The user that triggered the event.

Webhook payload example

{
  "action": "deleted",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Welcome Board",
    "members": [
      {
        "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
        "role": "owner"
      }
    ],
    "invited_members": [],
    "archived_date": "",
    "created_date": "2018-11-09T23:44:23.237Z",
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    },
    "labels": []
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "sequence": 4
}


labels_updated

Triggered when a label is added, updated, or deleted from the board.

Events API payload

Key Type Description
action string The string labels_updated.
board object The board the label belongs to.
sender object The user that triggered the event.
labels object An object containing lists of added, updated, and deleted labels.

Webhook payload example

{
  "action": "labels_updated",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "labels": {
    "added": [],
    "updated": [
      {
        "id": "5bfc0d0225ff0b000e6cb82a",
        "name": "Defect",
        "color": {
          "r": 240,
          "g": 147,
          "b": 43
        },
        "previous": {
          "id": "5bfc0d0225ff0b000e6cb82a",
          "name": "Bug",
          "color": {
            "r": 187,
            "g": 45,
            "b": 41,
            "a": 1
          }
        }
      }
    ],
    "deleted": []
  },
  "sequence": 15
}


members_updated

Triggered when a user is invited, joined, updated, or removed from the board.

Events API payload

Key Type Description
action string This action will be members_updated.
board object The board the member belongs to.
sender object The user that triggered the event.
members object An object containing lists of invited, joined, updated, and removed members.

Webhook payload example

{
  "action": "members_updated",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board",
    "members": [
      {
        "updated_date": "2018-11-26T15:12:37.493Z",
        "username": "keifwebhook",
        "name": "Keif",
        "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
        "role": "owner"
      }
    ],
    "invited_members": [
      {
        "updated_date": "2018-11-26T15:12:37.593Z",
        "username": "foobar",
        "name": "Foo Bar",
        "id": "4ecdeabd-c8f5-4b7d-a5e3-a484d62fd104",
        "role": "full"
      }
    ]
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "members": {
    "invited": [
      {
        "name": "Foo Bar",
        "id": "4ecdeabd-c8f5-4b7d-a5e3-a484d62fd104"
      }
    ],
    "joined": [],
    "updated": [],
    "removed": []
  },
  "sequence": 16
}

Column

Webhook Header

x-gk-event: columns


added

Triggered when a column is added.

Events API payload

Key Type Description
action string The string added.
board object The board the column belongs to.
sender object The user that triggered the event.
column object The column itself.

Webhook payload example

{
  "action": "added",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "column": {
    "id": "5bfc102c25ff0b000e6cb82d",
    "name": "In Progress",
    "created_date": "2018-11-26T15:24:28.948Z",
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    }
  },
  "sequence": 17
}


updated

Triggered when a column is renamed.

Events API payload

Key Type Description
action string The string updated.
board object The board the column belongs to.
sender object The user that triggered the event.
column object The column itself.

Webhook payload example

{
  "action": "updated",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "column": {
    "id": "5bfc102c25ff0b000e6cb82d",
    "name": "Needs Review",
    "previous": {
      "id": "5bfc102c25ff0b000e6cb82d",
      "name": "In Progress"
    }
  },
  "sequence": 18
}


reordered

Triggered when a column is moved.

Events API payload

Key Type Description
action string The string reordered.
board object The board the column belongs to.
sender object The user that triggered the event.
column object The column itself.

Webhook payload example

{
  "action": "reordered",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "column": {
    "id": "5bfc102c25ff0b000e6cb82d",
    "name": "Needs Review",
    "created_date": "2018-11-26T15:24:28.948Z",
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    },
    "position": 2
  },
  "sequence": 19
}

archived

Triggered when a column is archived.

Events API payload

Key Type Description
action string The string archived.
board object The board the column belongs to.
sender object The user that triggered the event.
column object The column itself.

Webhook payload example

{
  "action": "archived",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "column": {
    "id": "5bfc102c25ff0b000e6cb82d",
    "name": "Needs Review",
    "archived_date": "2018-11-26T15:28:49.052Z",
    "card_counts": {
      "unarchived": 0,
      "archived": 0,
      "pre_archived_cards": 0
    }
  },
  "sequence": 21
}


unarchived

Triggered when a column is unarchived.

Events API payload

Key Type Description
action string The string unarchived.
board object The board the column belongs to.
sender object The user that triggered the event.
column object The column itself.

Webhook payload example

{
  "action": "unarchived",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "column": {
    "id": "5bfc102c25ff0b000e6cb82d",
    "name": "Needs Review",
    "created_by": {
      "id": ""
    }
  },
  "sequence": 20
}


deleted

Triggered when a column is deleted.

Events API payload

Key Type Description
action string The string deleted.
board object The board the column belongs to.
sender object The user that triggered the event.
column object The column itself.

Webhook payload example

{
  "action": "deleted",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "column": {
    "id": "5bf41c0b6567c2000e91a79d",
    "name": "Making it Glo",
    "created_date": "2018-11-20T14:36:59.973Z",
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    }
  },
  "sequence": 22
}

Card

Webhook Header

x-gk-event: cards


added

Triggered when a card is added.

Events API payload

Key Type Description
action string The string added.
board object The board the card belongs to.
sender object The user that triggered the event.
card object The card itself.

Webhook payload example

{
  "action": "added",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "5bfc118325ff0b000e6cb82e",
    "name": "Create Webhook Documentation",
    "created_date": "2018-11-26T15:30:11.392Z",
    "board_id": "5bf41c0a6567c2000e91a792",
    "column_id": "5bf41c0b6567c2000e91a798",
    "labels": [],
    "assignees": [],
    "completed_task_count": 0,
    "total_task_count": 0,
    "attachment_count": 0,
    "comment_count": 0,
    "description": {},
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    }
  },
  "sequence": 23
}


updated

Triggered when a field on the card is updated (description, tasklist, etc.) or if the card is renamed.

Events API payload

Key Type Description
action string The string updated.
board object The board the card belongs to.
sender object The user that triggered the event.
card object The card itself.

Webhook payload example

{
  "action": "updated",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "5bfc118325ff0b000e6cb82e",
    "name": "Create Webhook Documentation",
    "created_date": "2018-11-26T15:30:11.392Z",
    "board_id": "5bf41c0a6567c2000e91a792",
    "column_id": "5bf41c0b6567c2000e91a798",
    "description": {
      "text": "This is a sample description."
    },
    "labels": [],
    "assignees": [],
    "completed_task_count": 0,
    "total_task_count": 0,
    "attachment_count": 0,
    "comment_count": 0,
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    },
    "previous": {
      "id": "5bfc118325ff0b000e6cb82e",
      "name": "Create Webhook Documentation",
      "description": {}
    }
  },
  "sequence": 24
}


copied

Triggered when a card is duplicated.

Events API payload

Key Type Description
action string The string copied.
board object The board the card belongs to.
sender object The user that triggered the event.
card object The card itself.

Webhook payload example

{
  "action": "copied",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "5bfc122225ff0b000e6cb82f",
    "name": "Create Webhook Documentation (1)",
    "created_date": "2018-11-26T15:32:50.102Z",
    "board_id": "5bf41c0a6567c2000e91a792",
    "column_id": "5bf41c0b6567c2000e91a798",
    "description": {
      "text": "This is a sample description."
    },
    "labels": [],
    "assignees": [],
    "completed_task_count": 0,
    "total_task_count": 0,
    "attachment_count": 0,
    "comment_count": 0,
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    }
  },
  "sequence": 25
}


archived

Triggered when a card is archived.

Events API payload

Key Type Description
action string The string archived.
board object The board the card belongs to.
sender object The user that triggered the event.
card object The card itself.

Webhook payload example

{
  "action": "archived",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "5bf41c0b6567c2000e91a79b",
    "name": "Inviting users and assigning roles"
  },
  "sequence": 26
}


unarchived

Triggered when a card is unarchived.

Events API payload

Key Type Description
action string The string unarchived.
board object The board the card belongs to.
sender object The user that triggered the event.
card object The card itself.

Webhook payload example

{
  "action": "unarchived",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "5bf41c0b6567c2000e91a79b",
    "name": "Inviting users and assigning roles"
  },
  "sequence": 27
}


deleted

Triggered when a card is deleted.

Events API payload

Key Type Description
action string The string deleted.
board object The board the card belongs to.
sender object The user that triggered the event.
card object The card itself.

Webhook payload example

{
  "action": "deleted",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "5bf41c0c6567c2000e91a79e",
    "name": "Using Glo on the web, in Atom, or VS Code",
    "created_date": "2018-11-20T14:37:00.061Z",
    "board_id": "5bf41c0a6567c2000e91a792",
    "column_id": "5bf41c0b6567c2000e91a798",
    "description": {
      "text": "Glo is designed to work where you work:\n\n- On the web at [https://app.gitkraken.com/glo](https://app.gitkraken.com/glo)\n- In Atom - [package instructions](https://support.gitkraken.com/gitkraken-glo/start-glo-ing#atom-plugin)\n- In VS Code - [extension instructions](https://support.gitkraken.com/gitkraken-glo/start-glo-ing#vscode-plugin)\n- In [GitKraken](https://gitkraken.com)"
    },
    "labels": [],
    "assignees": [],
    "completed_task_count": 0,
    "total_task_count": 0,
    "attachment_count": 0,
    "comment_count": 0,
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    }
  },
  "sequence": 28
}


reordered

Triggered when a card is moved within a column.

Events API payload

Key Type Description
action string The string deleted.
board object The board the card belongs to.
sender object The user that triggered the event.
card object The card itself.

Webhook payload example

{
  "action": "reordered",
  "board": {
    "id": "5bfc13d225ff0b000e6cb830",
    "name": "MEGALOVANIA"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "5bfc140925ff0b000e6cb832",
    "name": "Inviting users and assigning roles",
    "created_date": "2018-11-26T15:40:57.201Z",
    "board_id": "5bfc13d225ff0b000e6cb830",
    "column_id": "5bfc140825ff0b000e6cb831",
    "description": {
      "text": "When you're ready to start collaborating with teammates, they can be easily invited to a board by clicking the `Invite User` icon next to your avatar in the board, or, in **Board Settings > Users**."
    },
    "labels": [],
    "assignees": [],
    "completed_task_count": 0,
    "total_task_count": 0,
    "attachment_count": 0,
    "comment_count": 0,
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    },
    "position": 1
  },
  "sequence": 1
}


moved_column

Triggered when a card is moved to a different column within the board.

Events API payload

Key Type Description
action string The string moved_column.
board object The board the card belongs to.
sender object The user that triggered the event.
card object The card itself.

Webhook payload example

{
  "action": "moved_column",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "5bf41c0b6567c2000e91a79a",
    "name": "Managing Labels",
    "created_date": "2018-11-20T14:36:59.711Z",
    "board_id": "5bf41c0a6567c2000e91a792",
    "column_id": "5bf41c0b6567c2000e91a798",
    "description": {
      "text": "Labels are created at the board level and then applied to cards. You can create labels by going to **Board Settings > Labels** and clicking `Add a label`, or by clicking the `Manage Labels` icon when viewing card details.\n\nEditing the title or color of a label will update that label on every card to which it is applied.\n\nBONUS: You can also filter cards by label in the board by clicking on labels in **Board Settings > Labels**\n\n[Labels - Glo Support Site](https://support.gitkraken.com/gitkraken-glo/start-glo-ing#labels)"
    },
    "labels": [],
    "assignees": [],
    "completed_task_count": 0,
    "total_task_count": 0,
    "attachment_count": 0,
    "comment_count": 1,
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    },
    "position": 1
  },
  "sequence": 29
}


moved_to_board

Triggered when a card on the board is moved to a different board.

Events API payload

Key Type Description
action string The string moved_to_board.
board object The board the card belongs to and is moving from.
sender object The user that triggered the event.
new_card object The new card object that was created on the destination board.
card object The card itself.

Webhook payload example

{
  "action": "moved_to_board",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "5bf41c0b6567c2000e91a79b",
    "name": "Inviting users and assigning roles",
    "created_date": "2018-11-20T14:36:59.798Z",
    "board_id": "5bf41c0a6567c2000e91a792",
    "column_id": "5bf41c0b6567c2000e91a798",
    "description": {
      "text": "When you're ready to start collaborating with teammates, they can be easily invited to a board by clicking the `Invite User` icon next to your avatar in the board, or, in **Board Settings > Users**.  Glo users can be found by **name**, **username**, or by an _exact_ **email** match.\n\nIf your teammate does not yet have an account, they can easily be invited to Glo by entering their email address into the user search and sending an invite. They will receive an email asking them to create an account before they can accept the invite to your board.\n\nInvited users will be added to the board as a temporary, \"Invited User\" until they accept the invitation. In this state, they can be assigned to cards, but will not receive notifications until they accept.\n\n## User Roles\n\n### Owner\n- Delete board\n- Edit user roles to/from `Owner`\n\n### Admin\n- Archive board\n- Rename board\n- Add/remove board members\n- Edit user roles (except to/from `Owner`)\n- Delete __any__ comment\n\n### Edit\n- Add/edit/delete board labels\n- Add/edit/delete/archive columns\n- Move columns\n- Add/edit/delete/archive cards\n- Move cards\n- Add/edit comments\n- Delete __own__ comments\n\n### View\n- Remove self from board\n- View any card\n\n[Inviting Users - Glo Support Site](https://support.gitkraken.com/gitkraken-glo/start-glo-ing#invite-users)"
    },
    "labels": [],
    "assignees": [],
    "completed_task_count": 0,
    "total_task_count": 0,
    "attachment_count": 0,
    "comment_count": 0,
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    }
  },
  "new_card": {
    "id": "5bfc140925ff0b000e6cb832",
    "board_id": "5bfc13d225ff0b000e6cb830"
  },
  "sequence": 30
}


moved_from_board

Triggered when a card is moved to the board from another board.

Events API payload

Key Type Description
action string This action will be moved_from_board.
board object The board the card belongs to. This is also the board the card was moved to.
sender object The user that triggered the event.
old_card object The old card object that existed on the board the card orginated from.
card object The card itself.

Webhook payload example

{
  "action": "moved_from_board",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "5bfc148625ff0b000e6cb836",
    "name": "Keif Wardrobe",
    "created_date": "2018-11-26T15:43:02.795Z",
    "board_id": "5bf41c0a6567c2000e91a792",
    "column_id": "5bf41c0b6567c2000e91a798",
    "description": {
      "text": "![image](https://devapp.gitkraken.com/api/glo/boards/5bfc13d225ff0b000e6cb830/attachments/5bfc148773fee5000e3f7b06)\n"
    },
    "labels": [],
    "assignees": [],
    "completed_task_count": 0,
    "total_task_count": 0,
    "attachment_count": 1,
    "comment_count": 0,
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    }
  },
  "old_card": {
    "id": "5bfc144525ff0b000e6cb833",
    "board_id": "5bfc13d225ff0b000e6cb830"
  },
  "sequence": 31
}


labels_updated

Triggered when a label has been added or removed from a card.

Events API payload

Key Type Description
action string The string labels_updated.
board object The board the card belongs to.
sender object The user that triggered the event.
card object The card iteself.
labels object An object containing lists of added and removed labels.

Webhook payload example

{
  "action": "labels_updated",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "",
    "name": "f1"
  },
  "labels": {
    "added": [
      {
        "id": "5bf41cea6567c2000e91a7a0",
        "name": "Feature",
        "color": {
          "r": 31,
          "g": 126,
          "b": 56,
          "a": 1
        }
      }
    ],
    "removed": []
  },
  "sequence": 32
}


assignees_updated

Triggered when a member of the board is assigned or unassigned from a card.

Events API payload

Key Type Description
action string The string assignees_updated.
board object The board the card belongs to.
sender object The user that triggered the event.
card object The card itself.
assignees object The object containing lists of added and removed assignees.

Webhook payload example

{
  "action": "assignees_updated",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "5bf41c0c6567c2000e91a79f",
    "name": "Help & Documentation"
  },
  "assignees": {
    "added": [
      {
        "username": "foobar",
        "name": "Foo Bar",
        "id": "4ecdeabd-c8f5-4b7d-a5e3-a484d62fd104"
      }
    ],
    "removed": []
  },
  "sequence": 33
}

Comment

Webhook Header

x-gk-event: comments


added

Triggered when a comment is added.

Events API payload

Key Type Description
action string The string added.
board object The board the card and comment belong to.
sender object The user that triggered the event.
card object The card the comment belongs to.
comment object The comment itself.

Webhook payload example

{
  "action": "added",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "5bf41c0c6567c2000e91a79f",
    "name": "Help & Documentation"
  },
  "comment": {
    "id": "5bfc152725ff0b000e6cb837",
    "text": "This is looking great Foo! Can you update the description to also include a link to your PR?",
    "created_date": "2018-11-26T15:45:43.995Z",
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    }
  },
  "sequence": 34
}


updated

Triggered when a comment is updated.

Events API payload

Key Type Description
action string The string updated.
board object The board the card and comment belong to.
sender object The user that triggered the event.
card object The card the comment belongs to.
comment object The comment itself.

Webhook payload example

{
  "action": "updated",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "5bf41c0c6567c2000e91a79f",
    "name": "Help & Documentation"
  },
  "comment": {
    "id": "5bfc152725ff0b000e6cb837",
    "text": "This is looking great Foo! Can you update the description to also include a link to your pull request?",
    "created_date": "2018-11-26T15:45:43.995Z",
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    },
    "previous": {
      "id": "5bfc152725ff0b000e6cb837",
      "text": "This is looking great Foo! Can you update the description to also include a link to your PR?",
      "created_date": "2018-11-26T15:45:43.995Z",
      "created_by": {
        "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
      }
    }
  },
  "sequence": 35
}


deleted

Triggered when a comment is deleted.

Events API payload

Key Type Description
action string The string deleted.
board object The board the card and comment belong to.
sender object The user that triggered the event.
card object The card the comment belongs to.
comment object The comment itself.

Webhook payload example

{
  "action": "deleted",
  "board": {
    "id": "5bf41c0a6567c2000e91a792",
    "name": "Keif Board"
  },
  "sender": {
    "name": "Keif",
    "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c",
    "username": "keifwebhook"
  },
  "card": {
    "id": "5bf41c0c6567c2000e91a79f",
    "name": "Help & Documentation"
  },
  "comment": {
    "id": "5bfc152725ff0b000e6cb837",
    "text": "This is looking great Foo! Can you update the description to also include a link to your pull request?",
    "created_date": "2018-11-26T15:45:43.995Z",
    "created_by": {
      "id": "daec859f-dcd7-40c4-b2d3-6e74ab62426c"
    }
  },
  "sequence": 36
}