Skip to content

Universalis-FFXIV/alerts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

alerts

Codacy Badge GitHub Workflow Status

Alerts service for mogboard.

Notification methods

  • Email
  • Discord

Setup

Environment variables

  • UNIVERSALIS_MAILGUN_KEY - Your Mailgun API key
  • UNIVERSALIS_ALERTS_DISCORD_TOKEN - Your Discord bot token
  • UNIVERSALIS_ALERTS_EMAIL_ADDRESS - Your notifications email address

Endpoints

POST /discord/send

Sends a notification over Discord.

POST /email/send

Sends a notification over email.

Notification payload

{
    targetUser: string,
    notification: {
        itemName: string,
        pageUrl: string,
        reasons: string[]
    }
}

Testing environment variables

  • UNIALERTS_TEST_DISCORD_ID - The Discord account to which the test notification will be sent.