@acceliance/twenty-click-to-call 0.0.0-stage β†’ 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,3 +1,150 @@
1
- # Temporary Holding Version
1
+ [![Acceliance](https://www.acceliance.fr/media/wdxp1zys/logo-acc-seul-400.png)](https://www.acceliance.fr)
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ # Click to Call for Twenty, offered by Acceliance
4
+
5
+ **Your sales team calls contacts from their Android phone in one click, straight from [Twenty CRM](https://twenty.com), and every call is logged automatically. Free, open source, self-hostable.**
6
+
7
+ [![Maintained by Acceliance](https://img.shields.io/badge/maintained%20by-Acceliance-0097B6)](https://www.acceliance.fr)
8
+ [![License MIT](https://img.shields.io/badge/license-MIT-success)](LICENSE)
9
+ [![npm](https://img.shields.io/npm/v/@acceliance/twenty-click-to-call?logo=npm&label=npm)](https://www.npmjs.com/package/@acceliance/twenty-click-to-call)
10
+ [![CI](https://github.com/acceliance/twenty-click-to-call/actions/workflows/ci.yml/badge.svg)](https://github.com/acceliance/twenty-click-to-call/actions/workflows/ci.yml)
11
+ [![Twenty app](https://img.shields.io/badge/Twenty-2.59%2B-141414)](https://twenty.com)
12
+ [![ntfy](https://img.shields.io/badge/push-ntfy-317F6F)](https://ntfy.sh)
13
+ [![Android](https://img.shields.io/badge/phone-Android-3DDC84?logo=android&logoColor=white)](https://play.google.com/store/apps/details?id=io.heckel.ntfy)
14
+ [![Languages](https://img.shields.io/badge/languages-EN%20%C2%B7%20FR-1F6FEB)](#languages)
15
+ [![Self-hosted](https://img.shields.io/badge/data-stays%20on%20your%20servers-002395)](#requirements)
16
+
17
+ > **Using Twenty for sales?** Acceliance built this app for its own team and **offers** it to the Twenty community.
18
+ > Questions, feedback or a custom integration: **[contact@acceliance.fr](mailto:contact@acceliance.fr?subject=Twenty%20Click%20to%20Call)**.
19
+
20
+ ---
21
+
22
+ ## πŸš€ Why Click to Call?
23
+
24
+ Salespeople live in the CRM but call from their mobile. Copying numbers by hand is slow, error-prone, and calls rarely
25
+ get logged.
26
+
27
+ | | Before | With Click to Call |
28
+ |---|---|---|
29
+ | πŸ“ž **Dialing** | Read the number on screen, type it on the phone | One click in Twenty, one tap on the phone |
30
+ | βœ… **Accuracy** | Typos, wrong country code | Number normalized to international format (`+33…`) |
31
+ | πŸ“ **Activity log** | Calls forgotten in the CRM | Every call logged as a done task on the contact, assigned to the caller |
32
+ | πŸ—’οΈ **Call notes** | Written later, if ever | The task opens right away in the side panel, ready for notes |
33
+ | πŸ” **Privacy** | Numbers in third-party apps | Push through **your own** ntfy server; nothing else leaves your infrastructure |
34
+ | πŸ“± **Setup** | Custom mobile app to build and maintain | The free ntfy Android app, configured in two minutes |
35
+
36
+ ## ✨ What it does
37
+
38
+ 1. Click **Call** on a person in Twenty.
39
+ 2. Your phone gets a push notification with the contact's name, company and number.
40
+ 3. Tap it: the phone's dialer opens with the number ready. Press call.
41
+ 4. The call is logged as a **done task** on the contact, assigned to you, and opens in the side panel so you can take notes.
42
+
43
+ Notifications go through [ntfy](https://ntfy.sh), an open-source push service you can self-host. No custom mobile app is needed: your team uses the free ntfy Android app.
44
+
45
+ > Android never lets an app place a call silently: the dialer opens and the user presses call.
46
+
47
+ ## How it works
48
+
49
+ ```
50
+ Person ─[Call]─► front component ─POST /s/click-to-call/notify─► logic function
51
+ reads the contact with the caller's permissions, builds +33…, publishes to ntfy topic <prefix><user>
52
+ β–Ό
53
+ ntfy server ─► ntfy Android app ─tap─► dialer (tel:+33…)
54
+ ```
55
+
56
+ Each user receives notifications on their own topic: `<prefix>` + the part of their Twenty email before the `@`, made topic-safe. For `jane.doe@example.com` with the default prefix, that's `call-jane-doe`.
57
+
58
+ ## Requirements
59
+
60
+ - Twenty 2.59 or later, with logic functions enabled on self-hosted servers (`LOGIC_FUNCTION_TYPE=LOCAL` or `LAMBDA`).
61
+ - An ntfy server with access control. Self-hosting is strongly recommended: notifications contain contact names and phone numbers. A Docker setup takes a few minutes ([ntfy docs](https://docs.ntfy.sh/install/)).
62
+ - Android phones with the [ntfy app](https://play.google.com/store/apps/details?id=io.heckel.ntfy).
63
+
64
+ ## Setup
65
+
66
+ ### 1. ntfy server
67
+
68
+ Run ntfy with `auth-default-access: deny-all`, then create a publisher account and a token for Twenty:
69
+
70
+ ```bash
71
+ ntfy user add twenty
72
+ ntfy access twenty 'call-*' write-only
73
+ ntfy token add twenty # copy the tk_… token
74
+ ```
75
+
76
+ For each Twenty user (here `jane.doe@example.com`):
77
+
78
+ ```bash
79
+ ntfy user add jane-doe
80
+ ntfy access jane-doe call-jane-doe read-only
81
+ ```
82
+
83
+ ### 2. App settings in Twenty
84
+
85
+ Install the app, then open **Settings β†’ Apps β†’ Click to Call β†’ Variables**:
86
+
87
+ | Variable | Required | Default | Description |
88
+ | --- | --- | --- | --- |
89
+ | `NTFY_URL` | yes | | Your ntfy server, e.g. `https://ntfy.example.com` |
90
+ | `NTFY_TOKEN` | yes | | The publisher token (`tk_…`), stored as a secret |
91
+ | `NTFY_TOPIC_PREFIX` | no | `call-` | Topic prefix for each user |
92
+ | `CALL_TASK_TITLE` | no | `Call` | Title of the logged task (e.g. `Appel`). Empty = no task |
93
+
94
+ ### 3. Each phone
95
+
96
+ In the ntfy app: **Settings β†’ Manage users β†’ Add user** with your ntfy server and account, then **+** β†’ topic `call-jane-doe`, tick **Use another server**, enter your server URL and turn on **Instant delivery**.
97
+
98
+ Reload Twenty after installing or updating the app to see the button.
99
+
100
+ ## Permissions
101
+
102
+ The app reads the contact and the caller's workspace member, and creates the call task and its link to the contact. It never deletes records. Every action runs with the clicking user's own permissions on top of the app's role.
103
+
104
+ ## Languages
105
+
106
+ English and French (`locales/`). Contributions for other languages are welcome: run `twenty app translations extract --locale <locale>`.
107
+
108
+ ## Development
109
+
110
+ Requires Node 24.5+ and Yarn 4 (on Windows, use WSL 2).
111
+
112
+ ```bash
113
+ npm install -g twenty
114
+ yarn install
115
+ twenty auth login --url https://your-twenty.example.com
116
+ yarn typecheck && yarn test:unit
117
+ twenty app apply --create # first install; then `twenty app dev` or `twenty app apply`
118
+ ```
119
+
120
+ Releases are published to npm from GitHub Actions with provenance (`.github/workflows/publish.yml`): bump `version` in `package.json`, then push a `vX.Y.Z` tag.
121
+
122
+ ## License
123
+
124
+ [MIT](LICENSE) Β© Acceliance
125
+
126
+ ---
127
+
128
+ ## πŸ† Built by Acceliance
129
+
130
+ Click to Call is a small example of how **Acceliance** connects business tools with automation: a CRM button, a
131
+ serverless function, a self-hosted push service and the phone's own dialer, assembled into one smooth workflow with
132
+ no new mobile app to maintain.
133
+
134
+ - **Twenty CRM apps**: buttons, logic functions, workflows, data models and integrations for your sales process;
135
+ - **AI automation**: knowledge graphs, RAG, agents (MCP, A2A), governed AI and model-centric architectures;
136
+ - **Sovereign deployments**: on-premise or on the host of your choice, GDPR and AI Act ready.
137
+
138
+ Want the same approach for your own processes? **[Let's talk](mailto:contact@acceliance.fr?subject=Twenty%20%2F%20AI%20project)**.
139
+ See also our free AI candidate-matching platform, [CVMatcher](https://github.com/acceliance/CVMatcher-Deploy), and our
140
+ prompt generator, [MasterPrompter](https://masterprompter.acceliance.fr).
141
+
142
+ ## 🀝 About Acceliance
143
+
144
+ **Acceliance** designs AI and automation architectures and solutions: knowledge graphs, RAG, agents, business
145
+ modeling, AI governance and sovereign deployments.
146
+
147
+ πŸ“§ [contact@acceliance.fr](mailto:contact@acceliance.fr) Β· 🌐 [www.acceliance.fr](https://www.acceliance.fr) Β·
148
+ πŸ™ [github.com/acceliance](https://github.com/acceliance)
149
+
150
+ **Your CRM knows who to call. Now your phone does too.**