feat: Events via webhook (#771)

Closes #215, closes #656

server/.env.sample

@@ -46,6 +46,9 @@ SECRET_KEY=notsecretkey
 # SLACK_BOT_TOKEN=
 # SLACK_CHANNEL_ID=
 
+# WEBHOOK_URL=
+# WEBHOOK_BEARER=
+
 ## Do not edit this
 
 TZ=UTC

server/api/controllers/attachments/create.js

@@ -44,7 +44,7 @@ module.exports = {
   async fn(inputs, exits) {
     const { currentUser } = this.req;
 
-    const { card } = await sails.helpers.cards
+    const { card, board } = await sails.helpers.cards
       .getProjectPath(inputs.cardId)
       .intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
 
@@ -88,6 +88,7 @@ module.exports = {
         card,
         creatorUser: currentUser,
       },
+      board,
       requestId: inputs.requestId,
       request: this.req,
     });

server/api/controllers/card-memberships/create.js

@@ -45,7 +45,7 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    const { card } = await sails.helpers.cards
+    const { card, board } = await sails.helpers.cards
       .getProjectPath(inputs.cardId)
       .intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
 
@@ -74,6 +74,7 @@ module.exports = {
           card,
           userId: inputs.userId,
         },
+        board,
         request: this.req,
       })
       .intercept('userAlreadyCardMember', () => Errors.USER_ALREADY_CARD_MEMBER);

server/api/controllers/card-memberships/delete.js

@@ -39,7 +39,7 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    const { board } = await sails.helpers.cards
+    const { board, card } = await sails.helpers.cards
       .getProjectPath(inputs.cardId)
       .intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
 
@@ -67,6 +67,7 @@ module.exports = {
 
     cardMembership = await sails.helpers.cardMemberships.deleteOne.with({
       board,
+      card,
       record: cardMembership,
       request: this.req,
     });

server/api/controllers/comment-actions/delete.js

@@ -36,7 +36,7 @@ module.exports = {
       .intercept('pathNotFound', () => Errors.COMMENT_ACTION_NOT_FOUND);
 
     let { action } = path;
-    const { board, project } = path;
+    const { board, project, card } = path;
 
     const isProjectManager = await sails.helpers.users.isProjectManager(currentUser.id, project.id);
 
@@ -61,6 +61,7 @@ module.exports = {
 
     action = await sails.helpers.actions.deleteOne.with({
       board,
+      card,
       record: action,
       request: this.req,
     });

server/api/controllers/comment-actions/update.js

@@ -40,7 +40,7 @@ module.exports = {
       .intercept('pathNotFound', () => Errors.COMMENT_ACTION_NOT_FOUND);
 
     let { action } = path;
-    const { board, project } = path;
+    const { board, project, card } = path;
 
     const isProjectManager = await sails.helpers.users.isProjectManager(currentUser.id, project.id);
 
@@ -69,6 +69,7 @@ module.exports = {
 
     action = await sails.helpers.actions.updateOne.with({
       values,
+      card,
       board,
       record: action,
       request: this.req,

server/api/controllers/lists/delete.js

@@ -28,7 +28,8 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    let { list } = await sails.helpers.lists
+    // eslint-disable-next-line prefer-const
+    let { list, board } = await sails.helpers.lists
       .getProjectPath(inputs.id)
       .intercept('pathNotFound', () => Errors.LIST_NOT_FOUND);
 
@@ -47,6 +48,7 @@ module.exports = {
 
     list = await sails.helpers.lists.deleteOne.with({
       record: list,
+      board,
       request: this.req,
     });
 

server/api/controllers/lists/update.js

@@ -35,7 +35,8 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    let { list } = await sails.helpers.lists
+    // eslint-disable-next-line prefer-const
+    let { list, board } = await sails.helpers.lists
       .getProjectPath(inputs.id)
       .intercept('pathNotFound', () => Errors.LIST_NOT_FOUND);
 
@@ -56,6 +57,7 @@ module.exports = {
 
     list = await sails.helpers.lists.updateOne.with({
       values,
+      board,
       record: list,
       request: this.req,
     });

server/api/controllers/tasks/create.js

@@ -39,7 +39,7 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    const { card } = await sails.helpers.cards
+    const { card, board } = await sails.helpers.cards
       .getProjectPath(inputs.cardId)
       .intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
 
@@ -63,6 +63,7 @@ module.exports = {
         ...values,
         card,
       },
+      board,
       request: this.req,
     });
 

server/api/helpers/actions/create-one.js

@@ -95,6 +95,15 @@ module.exports = {
       buildAndSendSlackMessage(values.user, values.card, action);
     }
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'ACTION_CREATE',
+      data: action,
+      projectId: inputs.board.projectId,
+      user: inputs.request.currentUser,
+      card: values.card,
+      board: inputs.board,
+    });
+
     return action;
   },
 };

server/api/helpers/actions/delete-one.js

@@ -4,6 +4,10 @@ module.exports = {
       type: 'ref',
       required: true,
     },
+    card: {
+      type: 'ref',
+      required: true,
+    },
     board: {
       type: 'ref',
       required: true,
@@ -25,6 +29,15 @@ module.exports = {
         },
         inputs.request,
       );
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'ACTION_DELETE',
+        data: action,
+        projectId: inputs.board.projectId,
+        user: inputs.request.currentUser,
+        card: inputs.card,
+        board: inputs.board,
+      });
     }
 
     return action;

server/api/helpers/actions/update-one.js

@@ -8,6 +8,10 @@ module.exports = {
       type: 'json',
       required: true,
     },
+    card: {
+      type: 'ref',
+      required: true,
+    },
     board: {
       type: 'ref',
       required: true,
@@ -31,6 +35,15 @@ module.exports = {
         },
         inputs.request,
       );
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'ACTION_UPDATE',
+        data: action,
+        projectId: inputs.board.projectId,
+        user: inputs.request.currentUser,
+        card: inputs.card,
+        board: inputs.board,
+      });
     }
 
     return action;

server/api/helpers/attachments/create-one.js

@@ -21,6 +21,10 @@ module.exports = {
       custom: valuesValidator,
       required: true,
     },
+    board: {
+      type: 'ref',
+      required: true,
+    },
     requestId: {
       type: 'string',
       isNotEmptyString: true,
@@ -31,7 +35,7 @@ module.exports = {
   },
 
   async fn(inputs) {
-    const { values } = inputs;
+    const { values, board } = inputs;
 
     const attachment = await Attachment.create({
       ...values,
@@ -55,9 +59,20 @@ module.exports = {
         values: {
           coverAttachmentId: attachment.id,
         },
+        board,
+        request: inputs.request,
       });
     }
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'ATTACHMENT_CREATE',
+      data: attachment,
+      projectId: board.projectId,
+      user: inputs.request.currentUser,
+      card: values.card,
+      board,
+    });
+
     return attachment;
   },
 };

server/api/helpers/attachments/delete-one.js

@@ -48,6 +48,15 @@ module.exports = {
         },
         inputs.request,
       );
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'ATTACHMENT_DELETE',
+        data: attachment,
+        projectId: inputs.board.projectId,
+        user: inputs.request.currentUser,
+        card: inputs.card,
+        board: inputs.board,
+      });
     }
 
     return attachment;

server/api/helpers/attachments/update-one.js

@@ -31,6 +31,14 @@ module.exports = {
         },
         inputs.request,
       );
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'ATTACHMENT_UPDATE',
+        data: attachment,
+        projectId: inputs.board.projectId,
+        user: inputs.request.currentUser,
+        board: inputs.board,
+      });
     }
 
     return attachment;

server/api/helpers/boards/create-one.js

@@ -111,6 +111,14 @@ module.exports = {
       );
     });
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'BOARD_CREATE',
+      data: board,
+      projectId: board.projectId,
+      user: inputs.request.currentUser,
+      board,
+    });
+
     return {
       board,
       boardMembership,

server/api/helpers/boards/delete-one.js

@@ -35,6 +35,14 @@ module.exports = {
       });
     }
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'BOARD_DELETE',
+      data: board,
+      projectId: board.projectId,
+      user: inputs.request.currentUser,
+      board,
+    });
+
     return board;
   },
 };

server/api/helpers/boards/update-one.js

@@ -83,6 +83,14 @@ module.exports = {
       });
     }
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'BOARD_UPDATE',
+      data: board,
+      projectId: board.projectId,
+      user: inputs.request.currentUser,
+      board,
+    });
+
     return board;
   },
 };

server/api/helpers/card-memberships/create-one.js

@@ -21,6 +21,10 @@ module.exports = {
       custom: valuesValidator,
       required: true,
     },
+    board: {
+      type: 'ref',
+      required: true,
+    },
     request: {
       type: 'ref',
     },
@@ -75,6 +79,15 @@ module.exports = {
       );
     }
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'CARD_MEMBERSHIP_CREATE',
+      data: cardMembership,
+      projectId: inputs.board.projectId,
+      user: inputs.request.currentUser,
+      card: values.card,
+      board: inputs.board,
+    });
+
     return cardMembership;
   },
 };

server/api/helpers/card-memberships/delete-one.js

@@ -4,6 +4,10 @@ module.exports = {
       type: 'ref',
       required: true,
     },
+    card: {
+      type: 'ref',
+      required: true,
+    },
     board: {
       type: 'ref',
       required: true,
@@ -40,6 +44,15 @@ module.exports = {
           },
         });
       }
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'CARD_MEMBERSHIP_DELETE',
+        data: cardMembership,
+        projectId: inputs.board.projectId,
+        user: inputs.request.currentUser,
+        card: inputs.card,
+        board: inputs.board,
+      });
     }
 
     return cardMembership;

server/api/helpers/cards/create-one.js

@@ -109,6 +109,17 @@ module.exports = {
         user: values.creatorUser,
       },
       board: inputs.board,
+      request: inputs.request,
+    });
+
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'CARD_CREATE',
+      data: card,
+      projectId: inputs.board.projectId,
+      user: inputs.request.currentUser,
+      card,
+      board: inputs.board,
+      list: values.list,
     });
 
     return card;

server/api/helpers/cards/delete-one.js

@@ -21,6 +21,10 @@ module.exports = {
     const card = await Card.archiveOne(inputs.record.id);
 
     if (card) {
+      const { board } = await sails.helpers.lists
+        .getProjectPath(card.listId)
+        .intercept('pathNotFound', () => Errors.LIST_NOT_FOUND);
+
       sails.sockets.broadcast(
         `board:${card.boardId}`,
         'cardDelete',
@@ -33,6 +37,15 @@ module.exports = {
       if (sails.config.custom.slackBotToken) {
         buildAndSendSlackMessage(inputs.user, card);
       }
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'CARD_DELETE',
+        data: card,
+        projectId: board.projectId,
+        user: inputs.request.currentUser,
+        card,
+        board,
+      });
     }
 
     return card;

server/api/helpers/cards/duplicate-one.js

@@ -132,6 +132,17 @@ module.exports = {
         user: values.creatorUser,
       },
       board: inputs.board,
+      request: inputs.request,
+    });
+
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'CARD_CREATE',
+      data: card,
+      projectId: inputs.board.projectId,
+      user: inputs.request.currentUser,
+      card,
+      board: inputs.board,
+      list: inputs.list,
     });
 
     return {

server/api/helpers/cards/update-one.js

@@ -233,6 +233,7 @@ module.exports = {
             },
           },
           board: inputs.board,
+          request: inputs.request,
         });
       }
 
@@ -269,6 +270,15 @@ module.exports = {
       }
     }
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'CARD_UPDATE',
+      data: card,
+      projectId: inputs.board.projectId,
+      user: inputs.request.currentUser,
+      card,
+      board: inputs.board,
+    });
+
     return card;
   },
 };

server/api/helpers/lists/create-one.js

@@ -67,6 +67,14 @@ module.exports = {
       inputs.request,
     );
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'LIST_CREATE',
+      data: list,
+      projectId: values.board.projectId,
+      user: inputs.request.currentUser,
+      board: values.board,
+    });
+
     return list;
   },
 };

server/api/helpers/lists/delete-one.js

@@ -4,6 +4,10 @@ module.exports = {
       type: 'ref',
       required: true,
     },
+    board: {
+      type: 'ref',
+      required: true,
+    },
     request: {
       type: 'ref',
     },
@@ -21,6 +25,14 @@ module.exports = {
         },
         inputs.request,
       );
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'LIST_DELETE',
+        data: list,
+        projectId: inputs.board.projectId,
+        user: inputs.request.currentUser,
+        board: inputs.board,
+      });
     }
 
     return list;

server/api/helpers/lists/update-one.js

@@ -21,6 +21,10 @@ module.exports = {
       custom: valuesValidator,
       required: true,
     },
+    board: {
+      type: 'ref',
+      required: true,
+    },
     request: {
       type: 'ref',
     },
@@ -67,6 +71,14 @@ module.exports = {
         },
         inputs.request,
       );
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'LIST_UPDATE',
+        data: list,
+        projectId: inputs.board.projectId,
+        user: inputs.request.currentUser,
+        board: inputs.board,
+      });
     }
 
     return list;

server/api/helpers/projects/create-one.js

@@ -32,6 +32,13 @@ module.exports = {
       inputs.request,
     );
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'PROJECT_CREATE',
+      data: project,
+      projectId: project.id,
+      user: inputs.request.currentUser,
+    });
+
     return {
       project,
       projectManager,

server/api/helpers/projects/delete-one.js

@@ -37,6 +37,13 @@ module.exports = {
           inputs.request,
         );
       });
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'PROJECT_DELETE',
+        data: project,
+        projectId: project.id,
+        user: inputs.request.currentUser,
+      });
     }
 
     return project;

server/api/helpers/projects/update-one.js

@@ -108,6 +108,13 @@ module.exports = {
           inputs.request,
         );
       });
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'PROJECT_UPDATE',
+        data: project,
+        projectId: project.id,
+        user: inputs.request.currentUser,
+      });
     }
 
     return project;

server/api/helpers/tasks/create-one.js

@@ -21,6 +21,10 @@ module.exports = {
       custom: valuesValidator,
       required: true,
     },
+    board: {
+      type: 'ref',
+      required: true,
+    },
     request: {
       type: 'ref',
     },
@@ -67,6 +71,15 @@ module.exports = {
       inputs.request,
     );
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'TASK_CREATE',
+      data: task,
+      projectId: inputs.board.projectId,
+      user: inputs.request.currentUser,
+      card: values.card,
+      board: inputs.board,
+    });
+
     return task;
   },
 };

server/api/helpers/tasks/delete-one.js

@@ -25,6 +25,14 @@ module.exports = {
         },
         inputs.request,
       );
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'TASK_DELETE',
+        data: task,
+        projectId: inputs.board.projectId,
+        user: inputs.request.currentUser,
+        board: inputs.board,
+      });
     }
 
     return task;

server/api/helpers/tasks/update-one.js

@@ -71,6 +71,15 @@ module.exports = {
         },
         inputs.request,
       );
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'TASK_UPDATE',
+        data: task,
+        projectId: inputs.board.projectId,
+        user: inputs.request.currentUser,
+        card: values.card,
+        board: inputs.board,
+      });
     }
 
     return task;

server/api/helpers/users/create-one.js

@@ -84,6 +84,23 @@ module.exports = {
       );
     });
 
+    /* The user could be created manually by an user or via OIDC. We hijack the id field, so one can differentiate between the two on the webhook side. */
+    let initiator;
+    if (inputs.request && inputs.request.currentUser) {
+      initiator = inputs.request.currentUser;
+    } else {
+      initiator = {
+        id: 'oidc',
+      };
+    }
+
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'USER_CREATE',
+      data: { ...user, password: undefined },
+      projectId: '',
+      user: initiator,
+    });
+
     return user;
   },
 };

server/api/helpers/users/delete-one.js

@@ -59,6 +59,13 @@ module.exports = {
           inputs.request,
         );
       });
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'USER_DELETE',
+        data: { ...user, password: undefined },
+        projectId: '',
+        user: inputs.request.currentUser,
+      });
     }
 
     return user;

server/api/helpers/users/update-one.js

@@ -154,6 +154,13 @@ module.exports = {
           );
         });
       }
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'USER_UPDATE',
+        data: { ...user, password: undefined },
+        projectId: '',
+        user: inputs.request.currentUser,
+      });
     }
 
     return user;

server/api/helpers/utils/send-webhook.js

@@ -0,0 +1,115 @@
+const EVENT_TYPES = {
+  ACTION_CREATE: 'action_create',
+  ACTION_UPDATE: 'action_update',
+  ACTION_DELETE: 'action_delete',
+
+  CARD_CREATE: 'card_create',
+  CARD_UPDATE: 'card_update',
+  CARD_DELETE: 'card_delete',
+
+  CARD_MEMBERSHIP_CREATE: 'card_membership_create',
+  CARD_MEMBERSHIP_DELETE: 'card_membership_delete',
+
+  LIST_CREATE: 'list_create',
+  LIST_UPDATE: 'list_update',
+  LIST_DELETE: 'list_delete',
+
+  BOARD_CREATE: 'board_create',
+  BOARD_UPDATE: 'board_update',
+  BOARD_DELETE: 'board_delete',
+
+  ATTACHMENT_CREATE: 'attachment_create',
+  ATTACHMENT_UPDATE: 'attachment_update',
+  ATTACHMENT_DELETE: 'attachment_delete',
+
+  PROJECT_CREATE: 'project_create',
+  PROJECT_UPDATE: 'project_update',
+  PROJECT_DELETE: 'project_delete',
+
+  TASK_CREATE: 'task_create',
+  TASK_UPDATE: 'task_update',
+  TASK_DELETE: 'task_delete',
+
+  USER_CREATE: 'user_create',
+  USER_UPDATE: 'user_update',
+  USER_DELETE: 'user_delete',
+};
+
+/**
+ * Sends a webhook notification to a configured URL.
+ *
+ * @param {Object} inputs - Data to include in the webhook payload.
+ * @param {string} inputs.event - The event type (see {@link EVENT_TYPES}).
+ * @param {*} inputs.data - The actual data related to the event.
+ * @param {string} inputs.projectId - The project ID associated with the event.
+ * @param {ref} [inputs.user] - Optional user object associated with the event.
+ * @param {ref} [inputs.card] - Optional card object associated with the event.
+ * @param {ref} [inputs.board] - Optional board object associated with the event.
+ * @param {ref} [inputs.list] - Optional list object associated with the event.
+ * @returns {Promise<void>}
+ */
+async function sendWebhook(inputs) {
+  const url = sails.config.custom.webhookUrl;
+  const headers = {
+    'Content-Type': 'application/json',
+  };
+  if (sails.config.custom.webhookBearer) {
+    headers.Authorization = `Bearer ${sails.config.custom.webhookBearer}`;
+  }
+
+  const body = JSON.stringify({
+    ...inputs,
+    user: {
+      ...inputs.user,
+      password: undefined,
+    },
+  });
+
+  const req = await fetch(url, {
+    method: 'POST',
+    headers,
+    body,
+  });
+  if (req.status !== 200) {
+    sails.log.error(`Webhook failed with status ${req.status} and message: ${await req.text()}`);
+  }
+}
+
+module.exports = {
+  eventTypes: EVENT_TYPES,
+  inputs: {
+    event: {
+      type: 'string',
+      isIn: Object.keys(EVENT_TYPES),
+      required: true,
+    },
+    data: {
+      type: 'ref',
+      required: true,
+    },
+    projectId: {
+      type: 'string',
+      default: '',
+    },
+    user: {
+      type: 'ref',
+    },
+    card: {
+      type: 'ref',
+    },
+    board: {
+      type: 'ref',
+    },
+    list: {
+      type: 'ref',
+    },
+  },
+  async fn(inputs) {
+    if (!sails.config.custom.webhookUrl) return;
+    try {
+      await sendWebhook(inputs);
+    } catch (err) {
+      sails.log.error(err);
+    }
+  },
+};

server/config/custom.js

@@ -62,4 +62,7 @@ module.exports.custom = {
 
   slackBotToken: process.env.SLACK_BOT_TOKEN,
   slackChannelId: process.env.SLACK_CHANNEL_ID,
+
+  webhookUrl: process.env.WEBHOOK_URL,
+  webhookBearer: process.env.WEBHOOK_BEARER,
 };