Actions API¶

Operation actions use "type": "operation" plus the configuration of the operation they run:

{
  "name": "Nightly pipeline",
  "trigger_type": "Schedule",
  "actions": [
    {
      "type": "operation",
      "uuid": "3f8c1e42-9d77-4b6a-8f21-5c0a7b6d1e44",
      "schedule": {
        "type": "scan",
        "...": "the operation's own fields"
      }
    }
  ]
}

The operation's configuration goes inside the required schedule object, whose own type is sync, profile, scan, export, or materialize. The remaining fields are the same ones the matching operation accepts when you run it directly on a datastore.

Global Export actions use the type global_export:

{
  "name": "Weekly access review",
  "trigger_type": "Schedule",
  "crontab": "0 6 * * 1",
  "actions": [
    {
      "type": "global_export",
      "uuid": "8b1d7c3e-2f4a-4e9b-9c61-0d5e7a2b4f10",
      "asset_type": "user_permissions",
      "enrichment_datastore_id": 42
    }
  ]
}

Saving, updating, deleting, activating or deactivating, or manually executing a Flow with a user_permissions export requires the Admin role; with a check_templates export, the Manager role. A request without that role is refused with 403. See Flow Permissions.

Archive and Delete anomaly actions use the type anomaly:

Notification actions use "type": "notification", with notification_type picking the channel (InApp, Email, Slack, Microsoft Teams, or PagerDuty), tokenized_message carrying the message, and parameters holding the channel's settings. Three endpoints support them, described below.

Get Notification Specifications¶

Returns the configuration properties of each notification channel, as the form specifications the platform itself uses.

Endpoint: GET /flows/actions/notification/specifications

Permission: Member role or above

Pick the channel for its configuration properties.

curl -X GET "https://your-instance.qualytics.io/api/flows/actions/notification/specifications" \
  -H "Authorization: Bearer YOUR_TOKEN"

[
  {
    "display_name": "Email",
    "type": "Email",
    "properties": [
      {
        "field": "emails",
        "map_to": "parameters",
        "required": true,
        "title": "Email Addresses",
        "type": "string"
      },
      {
        "field": "email_subject",
        "map_to": "parameters",
        "required": false,
        "title": "Email Subject",
        "type": "tokenized"
      }
    ]
  }
]

Get Notification Tokens¶

Returns the message tokens available per trigger type, the same set for every channel.

Endpoint: GET /flows/actions/notification/tokens

Permission: Member role or above

curl -X GET "https://your-instance.qualytics.io/api/flows/actions/notification/tokens" \
  -H "Authorization: Bearer YOUR_TOKEN"

[
  {
    "trigger_type": "Anomaly",
    "valid_message_tokens": ["{{flow_name}}", "{{datastore_name}}", "{{container_name}}", "{{anomaly_message}}", "{{anomaly_type}}"],
    "optional_message_tokens": ["{{anomaly_message}}", "{{check_description}}", "{{old_status}}"],
    "default_message": "...",
    "default_subject": "{{anomaly_type}} anomaly in {{container_name}} ({{datastore_name}})"
  },
  {
    "trigger_type": "Operation",
    "valid_message_tokens": ["{{flow_name}}", "{{datastore_name}}", "{{operation_type}}", "{{operation_result}}"],
    "optional_message_tokens": ["{{operation_message}}"],
    "default_message": "...",
    "default_subject": "{{operation_result}}: {{operation_type}} operation on {{datastore_name}}"
  }
]

valid_message_tokens lists what the trigger provides, optional_message_tokens the subset that can arrive empty and is offered as optional sections, and default_subject the subject an Email notification opens on. Pass notification_type to shape default_message for the channel it will be delivered to; left out, the full Markdown default is returned.

Template Validation Errors¶

Creating or updating a Flow, which carries its actions, and testing a notification run the message and the Email subject through template validation; in the web app those are Publish and Test Notification. A refused template returns 422 Unprocessable Entity with detail carrying the first problem and an errors array carrying every problem; one publish reports all refused actions at once.

{
  "detail": "The message uses {{old_status}}, which this notification does not provide. A variable that is not provided is not filled in and reaches the recipient exactly as written.",
  "errors": [
    {
      "loc": ["actions", "6f1c2c1e-9d7a-4b0e-8a4f-2f7d1c9a0b11", "tokenized_message"],
      "msg": "The message uses {{old_status}}, which this notification does not provide. A variable that is not provided is not filled in and reaches the recipient exactly as written.",
      "type": "value_error.template"
    },
    {
      "loc": ["actions", "6f1c2c1e-9d7a-4b0e-8a4f-2f7d1c9a0b11", "parameters", "email_subject"],
      "msg": "The subject has a condition on {{ticket_number}}, which this notification does not provide. A condition can only check a variable this notification provides; otherwise its section would never be shown.",
      "type": "value_error.template"
    }
  ]
}

loc names the action by its uuid and then the field: tokenized_message for the message, parameters and email_subject for the subject. A malformed conditional, a variable missing its {{ or its }}, and a variable with spaces inside its braces are reported the same way, with msg saying what is wrong and quoting the fragment, for example The message has spaces inside the braces of {{ flow_name }}. A variable is only filled in when written without them, as {{flow_name}}; otherwise it reaches the recipient exactly as written.

Test Notification¶

Sends a test message with sample data to verify a notification's configuration before publishing.

Endpoint: POST /flows/actions/notifications/test

Permission: Member role or above

The body is a full notification action: type is always notification, the channel goes in notification_type, and both uuid and parameters are required. Pick the channel for its test request.

curl -X POST "https://your-instance.qualytics.io/api/flows/actions/notifications/test" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "uuid": "3f8c1e42-9d77-4b6a-8f21-5c0a7b6d1e44",
    "type": "notification",
    "notification_type": "Email",
    "tokenized_message": "Test notification from {{flow_name}}",
    "parameters": {
      "emails": "user@example.com",
      "email_subject": "Qualytics Test Alert"
    }
  }'

curl -X POST "https://your-instance.qualytics.io/api/flows/actions/notifications/test" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "uuid": "3f8c1e42-9d77-4b6a-8f21-5c0a7b6d1e44",
    "type": "notification",
    "notification_type": "Slack",
    "tokenized_message": "Test notification from {{flow_name}}",
    "parameters": {
      "channel": "general"
    }
  }'

curl -X POST "https://your-instance.qualytics.io/api/flows/actions/notifications/test" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "uuid": "3f8c1e42-9d77-4b6a-8f21-5c0a7b6d1e44",
    "type": "notification",
    "notification_type": "Microsoft Teams",
    "tokenized_message": "Test notification from {{flow_name}}",
    "parameters": {
      "channel": "general"
    }
  }'

curl -X POST "https://your-instance.qualytics.io/api/flows/actions/notifications/test" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "uuid": "3f8c1e42-9d77-4b6a-8f21-5c0a7b6d1e44",
    "type": "notification",
    "notification_type": "PagerDuty",
    "tokenized_message": "Test notification from {{flow_name}}",
    "parameters": {
      "severity": "info"
    }
  }'

Workflow actions (Webhook, HTTP Action, and n8n) share the notification shape, using "type": "notification":

Ticketing actions use the type values create_ticket and ticket_status_update: