Ali IlmanandGitHub
1957f839ff
## Background This is team Comfortably Summed's submission for Twenty's Hacktoberfest. We built an activity summary application that can periodically send messages to the following platforms: Slack; Discord; and WhatsApp. ### Features - 🧑💻 **People & Company Tracking**: Summarizes newly created people and companies - 🎯 **Opportunity Monitoring**: Reports on new opportunities created, broken down by stage - ✅ **Task Analytics**: - Tracks task creation - Calculates on-time completion rates - Identifies team members with the most overdue tasks (the "slackers") - 🔔 **Multi-Platform Notifications**: Send reports to Slack, Discord, and/or WhatsApp - ⏰ **Configurable Time Range**: Look back any number of days ### Summary of Changes - Adds a new Twenty app called Activity Summary - Contains a single index.ts file which utilises exported functions from opportunity-creation-summariser.ts, people-creation-summariser.ts, task-creation-summariser.ts, and senders.ts - Implementation of sending a message to Slack, Discord, and WhatsApp can be found in senders.ts - Retrieval and summarising of Opportunity creation can be found in opportunity-creation-summariser.ts - Retrieval and summarising of People creation can be found in people-creation-summariser.ts - Retrieval and summarising of Task creation can be found in task-creation-summariser.ts ## Screenshots ### Message to our Slack channel <details> <summary>Screenshot</summary> <img width="326" height="242" alt="Screenshot 2025-11-01 at 22 05 30" src="https://github.com/user-attachments/assets/57c5d50b-959d-4c3f-bd7d-00f42bf545b2" /> </details> ### Message to our Discord server's channel <details> <summary>Screenshot</summary> <img width="472" height="386" alt="Screenshot 2025-11-01 at 22 06 44" src="https://github.com/user-attachments/assets/f4a38d7f-e82d-47b0-a4b3-7bcf063fa575" /> </details> ### Message to our WhatsApp number <details> <summary>Screenshot</summary> <img width="972" height="548" alt="IMG_2024" src="https://github.com/user-attachments/assets/5533fc4d-a3ee-4e11-a9e7-9cc6a96316fc" /> </details> ### App-level configuration <details> <summary>Screenshot</summary> <img width="442" height="385" alt="Screenshot 2025-11-01 at 22 02 14" src="https://github.com/user-attachments/assets/c9948f57-f22c-42a0-972f-3348f480aa30" /> </details> ### Serverless functions <details> <summary>Screenshot</summary> <img width="413" height="378" alt="Screenshot 2025-11-01 at 22 03 48" src="https://github.com/user-attachments/assets/d297967b-52ce-4690-bb04-a16d89729d94" /> </details> ### Cron configuration Default value in place due to Cron having a non-editable text input. <details> <summary>Screenshot</summary> <img width="395" height="386" alt="Screenshot 2025-11-01 at 22 08 03" src="https://github.com/user-attachments/assets/a95a708c-7136-4512-99c3-a6723adc0da5" /> </details> ## Testing Sync the application to your Twenty instance and ensure the following variables have values: - `TWENTY_API_KEY` - Your Twenty CRM API key - `DAYS_AGO` - Number of days to look back for the report Choose any of the supported platforms and you shall see a summary being sent!
48 lines
1.5 KiB
JSON
48 lines
1.5 KiB
JSON
{
|
||
"version": "0.0.1",
|
||
"license": "MIT",
|
||
"engines": {
|
||
"node": "^24.5.0",
|
||
"npm": "please-use-yarn",
|
||
"yarn": ">=4.0.2"
|
||
},
|
||
"packageManager": "yarn@4.9.2",
|
||
"dependencies": {
|
||
"twenty-sdk": "0.0.3"
|
||
},
|
||
"devDependencies": {
|
||
"@types/node": "^24.7.2"
|
||
},
|
||
"$schema": "https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-cli/src/constants/schemas/appManifest.schema.json",
|
||
"universalIdentifier": "b53627f5-ca60-478c-bc43-c7ab4904e34a",
|
||
"name": "Activity Summary",
|
||
"description": "A TypeScript-based reporting bot that summarizes activity from your Twenty CRM workspace and sends daily/periodic reports to Slack, Discord, and WhatsApp. Meet Kylian Mbaguette, your friendly CRM activity reporter!",
|
||
"env": {
|
||
"TWENTY_API_KEY": {
|
||
"description": "Twenty API Key",
|
||
"isSecret": true
|
||
},
|
||
"DAYS_AGO": {
|
||
"description": "How far back into the past we want to summarise – defaults to the past 7 days",
|
||
"value": "7",
|
||
"isSecret": false
|
||
},
|
||
"SLACK_HOOK_URL": {
|
||
"description": "Slack hook URL for sending message to channel",
|
||
"isSecret": true
|
||
},
|
||
"DISCORD_WEBHOOK_URL": {
|
||
"description": "Discord webhook URL for sending message to channel of a server",
|
||
"isSecret": true
|
||
},
|
||
"FB_GRAPH_TOKEN": {
|
||
"description": "For Facebook auth",
|
||
"isSecret": true
|
||
},
|
||
"WHATSAPP_RECIPIENT_PHONE_NUMBER": {
|
||
"description": "Phone number for receiving WhatsApp message",
|
||
"isSecret": true
|
||
}
|
||
}
|
||
}
|