From 0b47645d5971a4deed1dcd27db431453f1e74de4 Mon Sep 17 00:00:00 2001 From: Mathis Van Eetvelde Date: Sun, 25 Jan 2026 15:32:54 -0700 Subject: [PATCH] Add audience information --- docs/getting-started/audience.md | 24 ++++++++++++++++++------ docs/reference/alerts-api.md | 1 + docs/reference/data-model.md | 7 ++++++- 3 files changed, 25 insertions(+), 7 deletions(-) diff --git a/docs/getting-started/audience.md b/docs/getting-started/audience.md index a84b30f..403c295 100644 --- a/docs/getting-started/audience.md +++ b/docs/getting-started/audience.md @@ -11,6 +11,8 @@ An **audience** is a named identifier (slug) that maps to verified contact metho - **Not** a user ID, email address, or phone number - A way to reference verified contact methods in your API calls +**Console-only management:** Audiences can only be created and managed through the [Notifox console](https://console.notifox.com/?view=audiences). There is no API for creating or managing audiences yet. You must use the web interface to create audiences, add contact methods, and verify them. + Each audience can have: * **At most one** verified phone number for SMS alerts (or none) * **At most one** verified email address for email alerts (or none) @@ -44,11 +46,15 @@ Enter your US phone number (it should start with `+1`). The form will help you f Click **Add Phone Number**. Notifox will automatically send a 6-digit verification code to that number via SMS. -A verification window will pop up automatically. Check your phone for the 6-digit code, then enter it in the prompt. +**Verification Process:** +1. You'll receive an SMS with a 6-digit code on the phone number you entered +2. A verification window will pop up automatically in the console +3. Enter the 6-digit code you received via SMS into the prompt in the console +4. This proves you own/control the phone number ![verify phone modal](./images/audience-3.png) -Once you've entered all 6 digits, you can press **Enter** to submit. If the code is correct, your phone number will be verified! +Once you've entered all 6 digits and pressed **Enter** to submit, if the code is correct, your phone number will be verified! You cannot use the phone number to send alerts until it's verified. **Tip:** If you don't receive the code, you can delete the phone number and try adding it again. @@ -58,11 +64,17 @@ In the detailed view, you'll also see an **Email** section with an **Add** butto ![add email modal](./images/audience-email-1.png) -Enter the email address you want to receive alerts at. Click **Add Email**. Notifox will send a verification email to that address. +Enter the email address you want to receive alerts at. Click **Add Email**. Notifox will automatically send a 6-digit verification code to that email address. + +**Verification Process:** +1. You'll receive an email with a 6-digit code at the email address you entered +2. A verification window will pop up automatically in the console +3. Enter the 6-digit code you received via email into the prompt in the console +4. This proves you own/control the email address -Check your inbox for the verification email and click the link inside to verify. Once verified, you can send email alerts to this audience. +Check your inbox for the verification email. Once you've entered all 6 digits and pressed **Enter** to submit, if the code is correct, your email address will be verified! You cannot use the email address to send alerts until it's verified. -**Tip:** Check your spam folder if you don't see the verification email. +**Tip:** Check your spam folder if you don't see the verification email. If you don't receive the code, you can delete the email address and try adding it again. ## That's it! @@ -70,7 +82,7 @@ Your audience is now ready to use. You'll see it listed on the [Audiences](https ![audiences list](./images/audience-4.png) -You can click the edit icon (pencil) next to any audience to manage it: add or remove phone numbers and email addresses, or delete the audience entirely. +You can click the edit icon (pencil) next to any audience to manage it: add or remove phone numbers and email addresses, or delete the audience entirely. All audience management must be done in the console—there is no API for managing audiences. ## Which channel to use? diff --git a/docs/reference/alerts-api.md b/docs/reference/alerts-api.md index 6b5c92d..dcdb5f4 100644 --- a/docs/reference/alerts-api.md +++ b/docs/reference/alerts-api.md @@ -27,6 +27,7 @@ The request body must be valid JSON containing: * The name of the audience to send the alert to * Must match a verified audience name in your account * Case-sensitive (e.g., `"joe"` and `"Joe"` are different audiences) + * **Note:** Audiences must be created and verified in the [Notifox console](https://console.notifox.com/?view=audiences) before you can send alerts to them. There is no API endpoint for creating or managing audiences. * `alert` (string, required) * The message text you want to send * Cannot be empty diff --git a/docs/reference/data-model.md b/docs/reference/data-model.md index 2a2d77e..0c947a2 100644 --- a/docs/reference/data-model.md +++ b/docs/reference/data-model.md @@ -63,6 +63,7 @@ An audience is a **named identifier (slug)** that maps to verified contact metho - An audience can have **at most one phone number** and **at most one email address** - An audience can have just a phone number, just an email address, or both - You must verify at least one contact method (phone or email) before sending alerts to that channel +- **Console-only management**: Audiences can only be created and managed through the web console. There is no API endpoint for creating, updating, or deleting audiences. You must use the [Notifox console](https://console.notifox.com/?view=audiences) for all audience management operations. **Example:** ```json @@ -162,7 +163,11 @@ Alert Request - All contact methods (phone numbers and email addresses) must be verified before use - Verification ensures you own/control the contact method - Unverified contact methods cannot receive alerts -- Verification is done via code sent to the contact method +- **Verification process**: + - **Phone numbers**: You receive a 6-digit code via SMS. Enter this code in the Notifox console to verify ownership. + - **Email addresses**: You receive a 6-digit code via email. Enter this code in the Notifox console to verify ownership. +- Verification must be completed in the console—you cannot verify contact methods via API +- This verification step is required for SMS compliance and ensures you actually own the phone number or email address ### Channel Selection - You choose the channel (`sms` or `email`) when sending each alert