@rubytech/taskmaster 1.11.0 → 1.11.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/dist/build-info.json
CHANGED
package/package.json
CHANGED
|
@@ -2,11 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
Walk the user through getting Brevo credentials. Brevo uses single sender verification — the user verifies an email address by entering a 6-digit code sent to it. No DNS records required. Guide with clear instructions.
|
|
4
4
|
|
|
5
|
+
**Important:** Brevo is primarily a marketing email platform. The signup flow and dashboard are oriented around marketing campaigns, contacts, and newsletters. The user does NOT need any of that. Guide them directly to the two things they need: a verified sender and an API key. Both are in the **Settings** page — accessed via the **gear icon** in the top-right toolbar. On the Settings page, both options are in the left sidebar under **Organization settings**.
|
|
6
|
+
|
|
5
7
|
---
|
|
6
8
|
|
|
7
9
|
## Prerequisites
|
|
8
10
|
|
|
9
11
|
- User has an email address they want OTP emails to come from (e.g. their business email)
|
|
12
|
+
- User has a mobile phone number (required by Brevo for account activation)
|
|
10
13
|
- Chat channel for sending instructions
|
|
11
14
|
|
|
12
15
|
---
|
|
@@ -21,50 +24,80 @@ Tell the user what Brevo is and why they need it:
|
|
|
21
24
|
|
|
22
25
|
## Step 2: Create a Brevo account
|
|
23
26
|
|
|
24
|
-
> "Go to **brevo.com** in your browser and click **Sign
|
|
27
|
+
> "Go to **brevo.com** in your browser and click **Sign Up Free** in the top-right corner.
|
|
25
28
|
>
|
|
26
29
|
> You'll need to enter:
|
|
27
|
-
> - Your email address
|
|
28
|
-
> - A password
|
|
30
|
+
> - Your **email address**
|
|
31
|
+
> - A **password**
|
|
32
|
+
>
|
|
33
|
+
> You can also sign up with Google or Apple if that's easier.
|
|
34
|
+
>
|
|
35
|
+
> After clicking **Create an account**, Brevo will send a confirmation email. Click the link in it to verify your account.
|
|
29
36
|
>
|
|
30
|
-
> Brevo will
|
|
37
|
+
> **Next, Brevo will ask for your mobile phone number.** This is for account activation only — they send a text to verify you're a real person. Enter your number and the code they text you.
|
|
38
|
+
>
|
|
39
|
+
> Let me know when you're past that and logged in."
|
|
40
|
+
|
|
41
|
+
Wait for the user to confirm they've completed signup and mobile verification.
|
|
31
42
|
|
|
32
|
-
|
|
43
|
+
### Getting past the onboarding
|
|
33
44
|
|
|
34
|
-
|
|
45
|
+
After signup, Brevo lands on a **"Getting Started"** page that tries to walk you through creating contacts, campaigns, and other marketing features. The user does NOT need any of this.
|
|
35
46
|
|
|
36
|
-
|
|
47
|
+
If the user mentions being on a "Getting Started" page, or asks about contacts/campaigns/templates:
|
|
48
|
+
|
|
49
|
+
> "You can skip all of that — it's for email marketing campaigns, which we don't need. We just need two things from Brevo: a verified sender address and an API key. Both are in the account settings. Let me show you where."
|
|
50
|
+
|
|
51
|
+
If the user is asked onboarding questions (company name, team size, etc.):
|
|
52
|
+
|
|
53
|
+
> "Just fill in your business name and pick whatever options feel right — those are for Brevo's records and don't affect anything we're doing."
|
|
37
54
|
|
|
38
55
|
## Step 3: Verify a sender email address
|
|
39
56
|
|
|
40
57
|
This determines what email address OTP codes come from. Brevo sends a 6-digit code to the email — no DNS records needed.
|
|
41
58
|
|
|
59
|
+
**Navigation: Settings page (gear icon) → Organization settings → Senders, domains, IPs.**
|
|
60
|
+
|
|
42
61
|
> "Now we need to verify the email address that verification codes will be sent from. This is what your visitors will see in their inbox.
|
|
43
62
|
>
|
|
44
|
-
> 1. In the
|
|
45
|
-
> 2.
|
|
46
|
-
> 3. Click **Add
|
|
63
|
+
> 1. In the **top-right toolbar**, click the **gear icon** (⚙️) to open **Settings**
|
|
64
|
+
> 2. In the Settings left sidebar, under **Organization settings**, click **Senders, domains, IPs**
|
|
65
|
+
> 3. Click the **Add sender** button (top-right of the page)
|
|
47
66
|
> 4. Fill in:
|
|
48
67
|
> - **From Name** — your business name (e.g. "Acme Plumbing")
|
|
49
68
|
> - **From Email** — the email you want codes to come from (your business email works)
|
|
50
|
-
> 5. Click **
|
|
69
|
+
> 5. Click **Add sender**
|
|
70
|
+
> 6. A popup will appear saying **"Authenticate your domain now?"** — you have two options:
|
|
71
|
+
> - **"Do it later"** — skip domain authentication. Sender verification alone is enough to send verification codes. Choose this if you don't own the email domain or want the simplest setup.
|
|
72
|
+
> - **"Authenticate domain"** — lets Brevo's partner (Entri) automatically add DKIM and DMARC records to your domain. This improves email deliverability and makes your emails fully compliant with Gmail/Yahoo/Microsoft requirements. Choose this if you own the domain and want more robust delivery. Entri will ask you to log in to your domain provider and it handles the DNS records automatically — no technical knowledge needed.
|
|
51
73
|
>
|
|
52
|
-
> Brevo will send a **6-digit code** to
|
|
74
|
+
> Either way, Brevo will send a **6-digit code** to your email address. Check your inbox (and spam folder), enter the code, and click **Verify**. Let me know when it's done."
|
|
75
|
+
|
|
76
|
+
If the user says they can't find it:
|
|
77
|
+
|
|
78
|
+
> "In the top-right of the Brevo dashboard, there's a toolbar with several small icons. Click the **gear icon** (⚙️) — it should be between the help icon and the notification bell. That opens the Settings page. Then look in the left sidebar for **Senders, domains, IPs** under the **Organization settings** section."
|
|
79
|
+
|
|
80
|
+
**Do NOT direct users to "Transactional" in the main dashboard sidebar or to "Campaigns".** Those are marketing features, not what they need.
|
|
53
81
|
|
|
54
82
|
Wait for the user to confirm.
|
|
55
83
|
|
|
56
84
|
## Step 4: Get an API key
|
|
57
85
|
|
|
86
|
+
**Navigation: same Settings page → Organization settings → SMTP & API.**
|
|
87
|
+
|
|
58
88
|
> "Almost done. Now we need an API key:
|
|
59
89
|
>
|
|
60
|
-
> 1.
|
|
61
|
-
> 2. Click **
|
|
62
|
-
> 3. Click
|
|
63
|
-
> 4.
|
|
64
|
-
> 5.
|
|
65
|
-
> 6. Click **Generate**
|
|
90
|
+
> 1. You should still be on the Settings page. In the left sidebar under **Organization settings**, click **SMTP & API**
|
|
91
|
+
> 2. Click the **API keys & MCP** tab (not the SMTP tab)
|
|
92
|
+
> 3. Click **Generate a new API key**
|
|
93
|
+
> 4. Give it a name like **Taskmaster**
|
|
94
|
+
> 5. Click **Generate**
|
|
66
95
|
>
|
|
67
|
-
> You'll see the API key — it starts with **xkeysib-** and is quite long. **Copy it now
|
|
96
|
+
> You'll see the API key — it starts with **xkeysib-** and is quite long. **Copy it now** — Brevo only shows it once. If you lose it, you'll need to generate a new one. Send me the key."
|
|
97
|
+
|
|
98
|
+
If the user navigated away from Settings:
|
|
99
|
+
|
|
100
|
+
> "Click the **gear icon** (⚙️) in the top-right toolbar to get back to Settings, then click **SMTP & API** in the left sidebar."
|
|
68
101
|
|
|
69
102
|
Wait for the user to send the API key.
|
|
70
103
|
|
|
@@ -96,7 +129,20 @@ Check if they have a verified sender:
|
|
|
96
129
|
|
|
97
130
|
If yes, skip to Step 4. If they're unsure:
|
|
98
131
|
|
|
99
|
-
> "
|
|
132
|
+
> "Click the **gear icon** (⚙️) in the top-right toolbar to open Settings. Then click **Senders, domains, IPs** in the left sidebar. Check if there's a verified sender listed. If not, we'll set one up."
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## Troubleshooting
|
|
137
|
+
|
|
138
|
+
| Problem | Solution |
|
|
139
|
+
|---------|----------|
|
|
140
|
+
| Can't find Senders or SMTP & API | Click the **gear icon** (⚙️) in the top-right toolbar to open the Settings page. Both options are in the left sidebar under **Organization settings**. |
|
|
141
|
+
| Landed on "Getting Started" or campaign builder | Ignore it — click the **gear icon** (⚙️) in the top-right toolbar to go straight to Settings. |
|
|
142
|
+
| "Transactional" page shows SMTP settings | Wrong place — that's in the main dashboard, not Settings. Click the **gear icon** (⚙️) in the top-right toolbar, then **SMTP & API** in the Settings sidebar. |
|
|
143
|
+
| Clicked "Authenticate domain" by mistake | If you end up on a Domains page or see DNS/Entri prompts, click **Cancel** or close the modal, then click the **Senders** tab to get back to sender verification. |
|
|
144
|
+
| Mobile verification code not arriving | Wait a minute and try again. Check you entered the right country code. Some VoIP numbers don't work — use a real mobile number. |
|
|
145
|
+
| Can't find the free plan | On brevo.com/pricing, the free tier is the green banner at the top of the page ("Free forever, no credit card needed"). Click **Sign up free** there. |
|
|
100
146
|
|
|
101
147
|
---
|
|
102
148
|
|
|
@@ -105,9 +151,11 @@ If yes, skip to Step 4. If they're unsure:
|
|
|
105
151
|
| Question | Answer |
|
|
106
152
|
|----------|--------|
|
|
107
153
|
| "Is it free?" | Yes — 300 emails per day, forever. No credit card required. For verification codes, that's more than enough. |
|
|
154
|
+
| "Why do they need my phone number?" | Brevo requires a mobile number for account activation — it's a one-time verification to prevent spam accounts. They won't call or text you after that. |
|
|
108
155
|
| "Can I use my Gmail/Outlook address?" | Yes, as long as you verify it by entering the 6-digit code Brevo sends to it. |
|
|
109
156
|
| "Will emails go to spam?" | OTP emails are solicited (the user just clicked 'send me a code'), so they almost always reach the inbox. If a visitor doesn't see it, tell them to check spam. |
|
|
110
|
-
| "I lost my API key" |
|
|
157
|
+
| "I lost my API key" | Click the gear icon (⚙️) in the top-right toolbar → SMTP & API → API keys & MCP tab, and generate a new one. |
|
|
111
158
|
| "Do I need to set up DNS records?" | No. Single sender verification works without DNS. Brevo will recommend domain authentication for better deliverability, but it's not required. |
|
|
112
159
|
| "Can I change the sender address later?" | Yes — add and verify a new sender in Brevo. Taskmaster auto-detects the verified sender, so no changes needed on this end. |
|
|
113
160
|
| "Where does Taskmaster get the sender address?" | Automatically from the Brevo API. When you verify a sender in Brevo, Taskmaster detects it — you don't need to enter it anywhere else. |
|
|
161
|
+
| "What about all the marketing stuff?" | Ignore it. Brevo is a full marketing platform, but we only use its transactional email API. You don't need to set up contacts, campaigns, or templates. |
|
|
@@ -1472,10 +1472,10 @@ By default, anyone who opens the public chat can start a conversation immediatel
|
|
|
1472
1472
|
| Method | How it works | What you need |
|
|
1473
1473
|
|--------|-------------|---------------|
|
|
1474
1474
|
| **Anonymous** | No verification — visitors chat immediately | Nothing (default) |
|
|
1475
|
-
| **Email OTP** | Visitors enter their email, receive a one-time code | A [
|
|
1475
|
+
| **Email OTP** | Visitors enter their email, receive a one-time code | A [Brevo](https://brevo.com) API key and a verified sender (free, no credit card). The sender address is configured in Brevo, not in Taskmaster. |
|
|
1476
1476
|
| **SMS OTP** | Visitors enter their phone number, receive a one-time code | [Twilio](https://twilio.com) account SID, auth token, and a Twilio phone number |
|
|
1477
1477
|
|
|
1478
|
-
5. Enter your provider credentials — for email, add the
|
|
1478
|
+
5. Enter your provider credentials — for email, add the Brevo API key in the **API Keys** section on the Setup page; for SMS, enter Twilio credentials in the SMS Fallback fields
|
|
1479
1479
|
6. Settings auto-save when you leave each field
|
|
1480
1480
|
|
|
1481
1481
|
Once enabled, visitors must authenticate before they can send their first message. Verified contact details are stored and available to the agent via the `verify_contact` tool, so your assistant knows who it's talking to.
|