config.json

{
  "name": "Email Notifications",
  "namespace": "ISGlobal\\EmailNotificationsExternalModule",
  "description": "Allows project administrators to schedule email notifications (every minute, hourly, daily, weekly or monthly) to one or more recipients summarizing record creation through REDCap API, i.e. REDCap Mobile App.",
  "authors": [
    {
      "name": "Maximo Ramirez Robles",
      "email": "maximo.ramirez@isglobal.org",
      "institution": "ISGlobal"
    }
  ],

  "crons": [
    {
      "cron_name": "minute_notifications",
      "cron_description": "Cron that runs every minute to check and notify if new records were created through the API",
      "method": "minuteNotifications",
      "cron_frequency": "60",
      "cron_max_run_time": "300"
    },
    {
      "cron_name": "hourly_notifications",
      "cron_description": "Cron that runs every hour to check and notify if new records were created through the API",
      "method": "hourlyNotifications",
      "cron_frequency": "3600",
      "cron_max_run_time": "300"
    },
    {
      "cron_name": "daily_notifications",
      "cron_description": "Cron that runs every day to check and notify if new records were created through the API",
      "method": "dailyNotifications",
      "cron_frequency": "86400",
      "cron_max_run_time": "300"
    },
    {
      "cron_name": "weekly_notifications",
      "cron_description": "Cron that runs every week to check and notify if new records were created through the API",
      "method": "weeklyNotifications",
      "cron_frequency": "604800",
      "cron_max_run_time": "300"
    },
    {
      "cron_name": "monthly_notifications",
      "cron_description": "Cron that runs every month to check and notify if new records were created through the API",
      "method": "monthlyNotifications",
      "cron_frequency": "2592000",
      "cron_max_run_time": "300"
    }
  ],

  "system-settings": [
    {
      "key": "sender",
      "name": "Sender email address",
      "type": "text",
      "required": true
    }
  ],

  "project-settings": [
    {
      "key": "recipients",
      "name": "Notification recipient",
      "type": "sub_settings",
      "repeatable": true,
      "sub_settings": [
        {
          "key": "user",
          "name": "User",
          "required" : true,
          "type": "user-list"
        },
        {
          "key": "frequency",
          "name": "Frequency",
          "required": true,
          "type": "dropdown",
          "choices": [
            {
              "value": "minute",
              "name": "Every minute"
            },
            {
              "value": "hourly",
              "name": "Hourly"
            },
            {
              "value": "daily",
              "name": "Daily"
            },
            {
              "value": "weekly",
              "name": "Weekly"
            },
            {
              "value": "monthly",
              "name": "Monthly"
            }
          ]
        }
      ]
    }
  ]
}