[Domínios API]

Invitation Domain

The Invitation domain manages short URL generation via a URL shortener service and email template administration. It provides admin capabilities for tracking invitation links, managing email communications, and testing e

Metadados do modulo

The Invitation domain manages short URL generation via a URL shortener service and email template administration. It provides admin capabilities for tracking invitation links, managing email communications, and testing e

Voltar a Todos os Módulos

Referencia de origem

content/modules/domain-invitation.md

Última Atualização

5 de fev. de 2026

Categoria

Domínios API

Checksum do conteudo

5ddf1b7b29105314

Etiquetas

api-domains

Documentacao renderizada

Esta pagina renderiza o Markdown e Mermaid do modulo diretamente da fonte publica de documentacao.

Overview#

The Invitation domain manages short URL generation via a URL shortener service and email template administration. It provides admin capabilities for tracking invitation links, managing email communications, and testing email delivery across environments.

Key Features#

  • Short URL creation with click tracking and timestamp recording
  • URL expiration support for time-limited invitation links
  • Type categorization for different link purposes (invitation, general, campaign)
  • Admin and user views for short URL management
  • Email template CRUD with tenant-scoped isolation
  • Variable substitution support with placeholder tracking
  • Dual format templates (HTML and plain text)
  • Active/inactive toggle for templates without deletion
  • Test email sending for delivery verification
  • Role-based access control (admin-only for management operations)

Use Cases#

  • Generating short invitation URLs with click tracking for user onboarding campaigns
  • Managing tenant-specific email templates for automated communications
  • Testing email delivery configurations before production use
  • Tracking invitation link engagement through click analytics

Integration#

The Invitation domain integrates with User for invitation management, Tenant for multi-tenant template scoping, Notification for email delivery tracking, and Authentication for invitation acceptance flow.

Last Reviewed: 2026-02-05