Scheduled Report Notification Schema

You can refer to this scheduled report notification schema to configure the payload template for a third-party webhook connector.

Schema

Copy

JSON

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
{
    "type": "string",
    "status": "string",
    "scheduled_time": number,
    "schedule_id": "string",
    "schedule": {
        "daily": {
        "hour": number,     
        "minute": number
        }
    },
    "run_once": boolean,
    "published": boolean,
    "publish_result": {
        "timestamp": number,
        "status": "string"
    },
    "notify_behavior": "string",
    "name": "string",
    "modified": {
        "by": string,
        "at": number
    },
    "id": string,
    "delete_empty_result": boolean,
    },
    "created": {
        "by": "string",
        "at": number
    },
    "artifact_data": {
        "result_id": "string",
        "result_count": number,
        "metadata": {
            "scheduled_report_name": "string",
            "schedule_id": "string",
            result_count": number,
            "report_type": "string",
            "report_id": "string",
            "report_description": "string",
            "customer_name": "string",
            "cadence": "string",
            "artifact_create_date": "string"
        },
        "create_time": number,
        "attachments": [
            {
                "url": "string",
                "name": "string"
            }
        ]
    },
    "account_id": "string",
    "extra": {
        "tld": "string",
        "ui_url": "string",
        "download_url": "string"    
    }
}

Definitions

type (string) – Schedule type
Value for a report schedule: tableau
status (string) – Current state of the scheduled report execution
Valid values: scheduled, running, completed, failed, canceled, deleted
scheduled_time (number) – Epoch time when the report is or was scheduled to run
schedule_id (string) – Schedule identifier
schedule (object) – Schedule frequency and time when report is scheduled to run
Valid values: every_15_minutes, daily, weekly, monthly
- daily (object)
  - minute (number) - Minute portion of time when report is scheduled to run
  - hour (number) - GMT hour when the report is scheduled to run in 24-hour clock format
- weekly (object)
  - day (string) - Day of the week when the report is scheduled to run
    Valid values: sunday, monday, tuesday, wednesday, thursday, friday
  - hour (number) - GMT hour when the report is scheduled to run in 24-hour clock format
  - minute (number) - Minute portion of time when report is scheduled to run
- monthly (object)
  - day (number) - Day of the month (1-31) when the report is scheduled to run
  - hour (number) - GMT hour when the report is scheduled to run in 24-hour clock format
  - minute (number) - Minute portion of time when report is scheduled to run
run_once (Boolean) - Whether the report was scheduled to be run only once. Schedule frequency is ignored if "true" is the value.
published (Boolean) - Whether a notification was sent
publish_result (object or string) - Result of sending the notification. A value of null means that the user does not request sending a notification; see notify_behavior.
- timestamp (number) - Epoch time stamp indicating when the notification was sent
- status (string) - Notification status
  Valid values: ok or an error
- notify_behavior (string) - Choice of when to send notifications
  Valid values: always, never, ifnotempty - send a notification only if execution returns results that are not empty; see result_count
- name (string) - Schedule name
- modified (object)
  - by(string) - User ID that changed the schedule
  - at (number) - Epoch time of the schedule change
- id (string) - Scheduled report execution ID
- delete_empty_result (Boolean) - Whether the notification and report are deleted automatically if results are empty
- created (object)
  - by(string) - User ID that created the schedule
  - at (number) - Epoch time of schedule creation
- artifact_data (object) - Information about the scheduled report
  - result_id (string) - Generated report identifier
  - result_count (number) - Whether the execution result is empty
    Valid values: 0 (empty),1 (if one or more)
  - metadata (object) - Information in the email notification sent to the customer when the scheduled report is generated
    - scheduled_report_name (string) - Name of the report schedule
    - schedule_id (string) - Schedule identifier
    - result_count (number) - Whether result of running the scheduled report is empty or not
      Valid values:0 (empty),1 (if one or more)
    - report_type (string) - Name of scheduled report as displayed in the Alert Logic console
    - report_id (string) - Report execution identifier
    - report_description (string) - Description of the report that appears in the Alert Logic console
    - customer_name (string) - Customer name of the Alert Logic account where the report was scheduled
    - cadence (string) - Schedule frequency and time when report is scheduled to run in human-readable format
    - artifact_create_date (string) - Date and time the scheduled report was generated in the format YYYY-MM-DD HH:MM GMT
  - create_time (number) - Epoch time when the report was generated
  - attachments (object) - Information used internally to attach the scheduled report to the notification email
    - url (string) - URL to download the report
    - name (string) - Name of the report as specified in the schedule with the report generation date appended
  - account_id (string) - Customer account identifier
  - extra (object) - Additional information about the scheduled report notification
    - tld (string) - Top-level Alert Logic domain of the customer based on the region in which the data resides
      Valid values: uk, us
    - ui_url (string) - URL that links to the scheduled report in the Alert Logic console
    - download_url (string) - URL for downloading the scheduled report from the Alert Logic console

Sample JSON

Alert Logic uses this JSON object to test connectors with a Scheduled Report Notification payload type.

Copy

JSON

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
{
    "type": "tableau",
    "status": "completed",
    "scheduled_time": 1596488400,
    "schedule_id": "8915CB92-A75C-1005-8001-0242AC110004",
    "schedule": {
        "daily": {
            "hour": 21
            "minute": 0,
        }
    },
    "run_once": false,
    "published": true,
    "publish_result": {
        "timestamp": 1596488406,
        "status": "ok"
    },
    "notify_behavior": "always",
    "name": "XYZ Corporation Azure Multi-Tenant CIS Benchmark",
    "modified": {
        "by": "A3CBF982-2FED-4E4B-9168-9E28F22FEEF3",
        "at": 1596488406
    },
    "id": "20200803-210000-8915CB92-A75C-1005-8001-0242AC110004",
    "delete_empty_result": false,
    },
    "created": {
        "by": "A3CBF982-2FED-4E4B-9168-9E28F22FEEF3",
        "at": 1596488400
    },
    "artifact_data": {
        "result_id": "6C3A6383-ABFF-1005-8001-0242AC110016",
        "result_count": 1,
        "metadata": {
            "scheduled_report_name": "XYZ Corporation Azure Multi-Tenant CIS Benchmark",
            "schedule_id": "8915CB92-A75C-1005-8001-0242AC110004",
            "result_count": 1,
            "report_type": "CIS Microsoft Azure Foundations Benchmark",
            "report_id": "20200803-210000-8915CB92-A75C-1005-8001-0242AC110004",
            "report_description": "This report displays the status of your environment to the CIS Microsoft Azure Foundations Benchmark Level 1 and 2.",
            "customer_name": "XYZ Corporation",
            "cadence": "Daily, 21:00 GMT",
            "artifact_create_date": "2020-08-03 21:00 GMT"
        },
        "create_time": 1596488404,
        "attachments": [
            {
                "url": "https://api.cloudinsight.alertlogic.com/cargo/v2/12345678/execution_record/20200803-210000-8915CB92-A75C-1005-8001-0242AC110004/result",
                "name": "XYZ Corporation Azure Multi-Tenant CIS Benchmark 2020-08-03 21:00 GMT.pdf"
            }
        ]
    },
    "account_id": "12345678",
    "extra": {
    "tld": "us",
    "ui_url": "https://console.alertlogic.com/fake/scheduled/report/url",
    "download_url": "https://console.alertlogic.com/fake/scheduled/report/url"
    }
}