plugin invitations - nself-org/cli GitHub Wiki

Invitations Plugin

User invitation system with email/SMS delivery and token-based join links. Free, MIT licensed.

Install

nself plugin install invitations

What It Does

Manages user invitations for your application. Generate token-based invite links, deliver them via email or SMS, track acceptance status, and enforce expiry. Integrates with ษณSelf Auth so accepted invitations automatically provision user accounts.

Configuration

Env Var Default Description
INVITATIONS_PORT 3402 Invitations service port
INVITATIONS_EXPIRY_HOURS 72 Hours before invite expires
INVITATIONS_BASE_URL โ€” Your app URL for invite links
INVITATIONS_SMTP_HOST โ€” SMTP host for email delivery

Ports

Port Purpose
3402 Invitations REST API

Database Tables

1 table added to your Postgres database:

  • np_invitations_invitations, invitation records, tokens, and status

Nginx Routes

None, invitations service is internal only.

API

GET  /health                    โ€” Health check
POST /invitations               โ€” Create and send invitation
GET  /invitations               โ€” List invitations
GET  /invitations/{token}       โ€” Verify an invite token
POST /invitations/{token}/accept โ€” Accept an invitation
DELETE /invitations/{id}        โ€” Revoke an invitation