Skip to content

Omnichannel Broadcasts — Content Types & Use Cases

Package: @vicacha-devs/strapi-plugin-broadcasts · Plugin ID: broadcasts · Admin Workspace: /admin/plugins/broadcasts

1. Content-Type Entities, Locations & Schemas (strapi.documents)

Section titled “1. Content-Type Entities, Locations & Schemas (strapi.documents)”

Registers three Collection Types (plugin::broadcasts.campaign, plugin::broadcasts.automation-rule, plugin::broadcasts.delivery-log). Campaigns store multi-channel message payloads; Automation Rules subscribe to Strapi eventHub events (e.g., entry.publish); Delivery Logs store idempotent (idempotencyKey), PII-masked (recipientMasked) audit trails. Supports schemaExtensions in config/plugins.ts.

Where to Find Content-Type Entities in Strapi v5

Section titled “Where to Find Content-Type Entities in Strapi v5”
  • Content Manager: /admin/content-manager/collection-types/plugin::broadcasts.campaign, plugin::broadcasts.automation-rule, and plugin::broadcasts.delivery-log (visible: true)
  • Content-Type Builder: /admin/plugins/content-type-builder under Collection Types
  • Plugin Workspace & Settings: /admin/plugins/broadcasts (Campaigns, Automation Rules, Delivery Audit) and /admin/settings/broadcasts
  • Database Tables: broadcast_campaigns, broadcast_automation_rules, and broadcast_delivery_logs

plugin::broadcasts.automation-rule — Broadcast Automation Rule

Section titled “plugin::broadcasts.automation-rule — Broadcast Automation Rule”

EventHub-driven automated multi-channel broadcast rule

Kind: collectionType · DB Table: broadcast_automation_rules · Admin Location: /admin/content-manager/collection-types/plugin::broadcasts.automation-rule · Draft & Publish: No · i18n: No

Attribute Strapi Type Required Constraints / Target
name string Yes —
slug uid Yes —
eventName string Yes —
targetContentType string No —
topic string Yes default: "announcements"
channels json Yes default: ["telegram"]
active boolean No default: true
priority enumeration No enum: low, normal, high, urgent; default: "normal"
subjectTemplate string Yes —
bodyTextTemplate text Yes —
bodyHtmlTemplate richtext No —
ctaLabelTemplate string No —
ctaUrlTemplate string No —
translations json No default: {}
lastTriggeredAt datetime No —
triggerCount integer No default: 0

plugin::broadcasts.campaign — Broadcast Campaign

Section titled “plugin::broadcasts.campaign — Broadcast Campaign”

Omnichannel Email, Telegram & WhatsApp broadcast campaign

Kind: collectionType · DB Table: broadcast_campaigns · Admin Location: /admin/content-manager/collection-types/plugin::broadcasts.campaign · Draft & Publish: No · i18n: No

Attribute Strapi Type Required Constraints / Target
title string Yes —
slug uid Yes —
topic string Yes default: "announcements"
channels json Yes default: ["email","telegram"]
priority enumeration Yes enum: low, normal, high, urgent; default: "normal"
status enumeration Yes enum: draft, scheduled, sending, sent, failed, cancelled; default: "draft"
scheduledAt datetime No —
sentAt datetime No —
subject string Yes —
bodyText text Yes —
bodyHtml richtext No —
ctaLabel string No —
ctaUrl string No —
mediaUrl string No —
emailTemplateRef string No —
whatsappTemplateName string No —
whatsappGroupIds json No default: []
telegramChatId string No —
telegramThreadId integer No —
translations json No default: {}
secondaryDate json No default: {}
secondaryDateLabel string No —
stats json No default: {}
metadata json No default: {}

plugin::broadcasts.delivery-log — Broadcast Delivery Log

Section titled “plugin::broadcasts.delivery-log — Broadcast Delivery Log”

Idempotent, PII-masked multi-channel delivery audit log

Kind: collectionType · DB Table: broadcast_delivery_logs · Admin Location: /admin/content-manager/collection-types/plugin::broadcasts.delivery-log · Draft & Publish: No · i18n: No

Attribute Strapi Type Required Constraints / Target
idempotencyKey string Yes —
campaignSlug string Yes —
channel enumeration Yes enum: email, telegram, whatsapp
driver string Yes —
recipientMasked string Yes —
locale string Yes default: "es"
status enumeration Yes enum: sent, simulated, skipped_duplicate, failed
externalMessageId string No —
errorMessage text No —
sentAt datetime Yes —
secondaryDateLabel string No —

Strapi v5 Content Manager Integration (/admin/content-manager)

Section titled “Strapi v5 Content Manager Integration (/admin/content-manager)”

Content Manager Sidebar Group: Inbox & Omnichannel Broadcasts

  • plugin::broadcasts.campaign (Broadcast Campaign — /admin/content-manager/collection-types/plugin::broadcasts.campaign)
  • plugin::broadcasts.automation-rule (Broadcast Automation Rule — /admin/content-manager/collection-types/plugin::broadcasts.automation-rule)
  • plugin::broadcasts.delivery-log (Broadcast Delivery Log — /admin/content-manager/collection-types/plugin::broadcasts.delivery-log)

Omnichannel Broadcasts — Strapi v5 Content Manager Entities & Editorial View

Why This Plugin Creates & Integrates Content Manager Entities

Section titled “Why This Plugin Creates & Integrates Content Manager Entities”

@vicacha-devs/strapi-plugin-broadcasts exposes all three of its entities (Broadcast Campaign, Broadcast Automation Rule, and Broadcast Delivery Log) in the Strapi v5 Content Manager so communication teams can author rich campaign payloads, audit PII-masked delivery logs, and govern access via native RBAC:

  • Structured Campaign Authoring & Review: Draft bodyHtml, bodyText, telegramParseMode, whatsappTemplateName, and ctaUrl in Content Manager with collaborative @vicacha-devs/strapi-plugin-notes annotations before dispatching from /admin/plugins/broadcasts.
  • Declarative EventHub Rule Management: Inspect and bulk-toggle Broadcast Automation Rule (plugin::broadcasts.automation-rule) triggers (entry.publish, entry.create) and Mustache templates ({{title}}, {{slug}}) in Content Manager.
  • Compliance & Delivery Log Auditing: Filter Broadcast Delivery Log (plugin::broadcasts.delivery-log) by channel, status (sent, failed, skipped_duplicate), idempotencyKey, and recipientMasked using Content Manager’s native search and pagination.
  • Role-Based Access Separation: Grant copywriters Content Manager permission to draft plugin::broadcasts.campaign records while restricting actual live dispatch (POST /broadcasts/campaigns/{id}/send) to senior administrators.

How to Use in Strapi Content Manager (Step-by-Step)

Section titled “How to Use in Strapi Content Manager (Step-by-Step)”
  1. Open in Content Manager: Navigate to Content Manager -> Collection Types -> Inbox & Omnichannel Broadcasts and select Broadcast Campaign, Broadcast Automation Rule, or Broadcast Delivery Log.
  2. Author & Schedule Campaigns: In Broadcast Campaign (/admin/content-manager/collection-types/plugin::broadcasts.campaign), create an entry with title, slug, topic, targetLocale, channels (['email', 'telegram', 'whatsapp']), and channel-specific templates.
  3. Configure EventHub Automation Rules: In Broadcast Automation Rule (/admin/content-manager/collection-types/plugin::broadcasts.automation-rule), bind eventName (entry.publish) and targetContentType (e.g., plugin::events.event or plugin::islam.hilal-announcement).
  4. Workspace vs. Content Manager: Use Content Manager to draft campaign copy, attach review notes, and query Broadcast Delivery Log history; use the Broadcasts Workspace (/admin/plugins/broadcasts) to execute dry-run previews and trigger live omnichannel sends.

Content Manager & Plugin Workspace Synchronization

Section titled “Content Manager & Plugin Workspace Synchronization”

Content Manager Use Cases & Editorial Workflows

Section titled “Content Manager Use Cases & Editorial Workflows”

Content Manager Use Case 1 — Two-Stage Editorial Approval Before Omnichannel Dispatch

Section titled “Content Manager Use Case 1 — Two-Stage Editorial Approval Before Omnichannel Dispatch”
  • Why & What it is for: Allow editors to prepare multilingual campaign copy and WhatsApp template variables in Content Manager while a reviewer leaves approval notes before sending.
  • How to use in Content Manager: Create a Broadcast Campaign with status: 'draft' in /admin/content-manager/collection-types/plugin::broadcasts.campaign, review it via the Content Manager Notes panel, and dispatch it from /admin/plugins/broadcasts.

Content Manager Use Case 2 — Filtering Failed or Skipped Delivery Logs by Channel & Campaign

Section titled “Content Manager Use Case 2 — Filtering Failed or Skipped Delivery Logs by Channel & Campaign”
  • Why & What it is for: Investigate delivery failures or idempotent duplicate skips across Email, Telegram, and WhatsApp without exposing raw subscriber PII.
  • How to use in Content Manager: Open /admin/content-manager/collection-types/plugin::broadcasts.delivery-log and filter by status = failed or channel = whatsapp to inspect errorMessage and recipientMasked.

Use Case 1 — Omnichannel Manual & Scheduled Community Campaigns

Section titled “Use Case 1 — Omnichannel Manual & Scheduled Community Campaigns”
  • What it is for: Dispatch announcements simultaneously across Email (SMTP/Resend), Telegram Bot channels/threads, and WhatsApp Cloud API.
  • How it works: Create a plugin::broadcasts.campaign entity with channels: ['email', 'telegram', 'whatsapp'], preview via POST /broadcasts/campaigns/{id}/dry-run, and dispatch via POST /broadcasts/campaigns/{id}/send.

Omnichannel Broadcasts — Strapi v5 Admin Workspace

Use Case 2 — EventHub Zero-Touch Publish Automation

Section titled “Use Case 2 — EventHub Zero-Touch Publish Automation”
  • What it is for: Automatically broadcast a Telegram/WhatsApp notification whenever an editor publishes a new Event, Hilal Announcement, or Urgent Campaign.
  • How it works: Create a plugin::broadcasts.automation-rule entity matching eventName: 'entry.publish' and targetContentType: 'plugin::events.event' with Mustache-style subjectTemplate and bodyTextTemplate.

Omnichannel Broadcasts — Strapi v5 Settings Panel

Use Case 3 — Idempotent PII-Masked Delivery Auditing

Section titled “Use Case 3 — Idempotent PII-Masked Delivery Auditing”
  • What it is for: Guarantee no subscriber receives duplicate messages on retry while keeping phone numbers and emails masked in database logs.
  • How it works: Every dispatch computes a deterministic idempotencyKey recorded in plugin::broadcasts.delivery-log with recipientMasked (j***@example.org, +57***4821).

Omnichannel Broadcasts — Strapi v5 Content Manager Entities