NUnullplatform
Inbox rules

List inbox rules

Changed on

Lists the built-in inbox rules and your organization's own, active and deactivated.

Built-in rules also carry organization_state: whether the rule is on for your organization and whether you edited it.

get/communications/inbox_rule

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/communications/inbox_rule
  • Auth
    HTTP bearer

Response

The built-in inbox rules and your organization's own.

Example response

{
  "results": [
    {
      "id": "acme.security_finding",
      "organization_id": 1,
      "publisher": "organization",
      "status": "active",
      "document": {
        "id": "acme.security_finding",
        "status": "active",
        "context_schema": {
          "type": "object",
          "required": [
            "id",
            "service",
            "owner_id"
          ],
          "properties": {
            "id": {
              "type": "string"
            },
            "service": {
              "type": "string"
            },
            "summary": {
              "type": "string"
            },
            "owner_id": {
              "type": "integer"
            }
          }
        },
        "category": {
          "group": "security",
          "label": "Security findings",
          "description": "Vulnerabilities your CI scanners report.",
          "configurable": true,
          "allows_all": true,
          "default_mode": "involved"
        },
        "severity": "degraded",
        "audience": [
          {
            "as": "owner",
            "who": {
              "user": "${{ context.owner_id }}"
            },
            "action": "acme.security_finding",
            "content": {
              "title": "Security finding on ${{ context.service }}",
              "body": "${{ context.summary }}"
            }
          }
        ],
        "visible_to": [
          "organization=1:account=2"
        ]
      },
      "created_at": "2026-10-20T14:03:11.000Z",
      "updated_at": "2026-10-20T14:03:11.000Z",
      "organization_state": {
        "enabled": true,
        "linked": []
      }
    }
  ]
}

Changes