Skip to main content
View as Markdown

Notification Settings

info

The English user guide is currently in beta preview. Most of the documents have been automatically translated from the Japanese version. Should you find any inaccuracies, please reach out to Flatt Security.

You can receive a notification from Takumi when an assessment completes.

Destinations​

The following three types are available:

  • Slack channel — a channel of an integrated Slack workspace. See Integrate Slack for how to integrate one.
  • Email address — email addresses of the organization's members, or addresses in the organization's email allowlist.
  • Webhook — a webhook URL registered for the organization. See Setting Up Webhook Endpoints for how to register one.

How to Configure​

  • The waiting screen of a running assessment — set them from the screen shown after an assessment starts.

    Slack, Email, and Webhook buttons under "Get notified"

  • A periodic assessment — set them under "Notifications" in the periodic assessment settings. They apply to every assessment that periodic assessment creates from then on.

    "Notifications" in the periodic assessment settings

Webhook Format​

When you choose a webhook, the data sent has the format below. For other common specifications, see Webhook Notifications.

FieldDescription
assessment_idID of the assessment.
assessment_nameName of the assessment.
statusStatus of the assessment after the event: one of CRAWLED (assessment.crawled), COMPLETED (assessment.completed), or PENDING (assessment.pending).
urlURL of the assessment page in the console.
finding_countsNumber of findings per severity: critical, high, medium, low, and none. Present in assessment.completed and assessment.pending.

A sample assessment.completed:

{
  "type": "assessment.completed",
  "timestamp": "2026-10-27T03:00:00Z",
  "data": {
    "assessment_id": "AS01J...",
    "assessment_name": "Weekly scan of flatt.tech",
    "status": "COMPLETED",
    "url": "https://cloud.shisho.dev/{org_id}/assessments/AS01J...",
    "finding_counts": {
      "critical": 1,
      "high": 2,
      "medium": 0,
      "low": 1,
      "none": 0
    }
  }
}

A sample assessment.pending:

{
  "type": "assessment.pending",
  "timestamp": "2026-10-27T03:00:00Z",
  "data": {
    "assessment_id": "AS01J...",
    "assessment_name": "Weekly scan of flatt.tech",
    "status": "PENDING",
    "url": "https://cloud.shisho.dev/{org_id}/assessments/AS01J...",
    "finding_counts": {
      "critical": 1,
      "high": 2,
      "medium": 0,
      "low": 1,
      "none": 0
    }
  }
}

A sample assessment.crawled:

{
  "type": "assessment.crawled",
  "timestamp": "2026-10-27T03:00:00Z",
  "data": {
    "assessment_id": "AS01J...",
    "assessment_name": "Weekly scan of flatt.tech",
    "status": "CRAWLED",
    "url": "https://cloud.shisho.dev/{org_id}/assessments/AS01J..."
  }
}
Last updated on