Notifications

Ask

Prompts users for input with predefined response options.

Ask - Parameters Schema

{
        "subject": string (required),
        "message": string (required),
        "event_details": EventDetails (required),
        "user_response_options": string[] (required),
        "response_option_after_timeout": string (required),
        "notification_profile": string | AutoParamRef (required)
        }

Ask - Parameters Detail

• subject (string, required): Question or prompt title (max length is 300 characters)

• message (string, required): Detailed message or description (max length is 600 characters)

• event_details (object, required): Structured information to display to users in notifications and prompts. This allows you to present relevant context data in a formatted way, such as IP addresses, user names, timestamps, or any other relevant information from the automation flow.

  {
              "enabled": boolean,
              "event_details_fields": [
              {
              "name": string,
              "value": string | number | ParamRef
              }
              ]
              }

• user_response_options (array, required): Exactly 2 unique response options

• response_option_after_timeout (string, required): Default response if user do not respond (must match one of the response options)

• notification_profile (string, required): Notification delivery method that determines how and to whom the notification is sent. This refers to predefined notification profiles configured in your Playblocks system, such as Immediate attention, Low attention, or custom profiles that specify recipients, delivery channels (such as email, SMS, and so on), and timing preferences.

Ask - Example

{
        "type": "Ask",
        "name": "Approve Action",
        "parameters": {
        "subject": "Suspicious activity detected",
        "message": "Should we block this IP address?",
        "event_details": {
        "enabled": true,
        "event_details_fields": [
        {
        "name": "IP Address",
        "value": "{{step['Log Trigger']['client_ip']}}"
        }
        ]
        },
        "user_response_options": ["Block", "Ignore"],
        "response_option_after_timeout": "Block",
        "notification_profile": "Immediate attention"
        }
        }

Notify

Sends notifications to users or teams.

Notify - Parameters Schema

{
        "subject": string | ParamRef (required),
        "message": string | ParamRef (optional),
        "event_details": EventDetails (required),
        "notification_profile": string | AutoParamRef (required)
        }

Notify - Parameters Detail

• subject (string/ParamRef, required): Notification subject/title (max length is 300 characters)

• message (string/ParamRef, optional): Notification body message (max length is 600 characters)

• event_details (object, required): Structured information to display to users in notifications and prompts. This allows you to present relevant context data in a formatted way, such as IP addresses, user names, timestamps, or any other relevant information from the automation flow.

• notification_profile (string, required): Notification delivery method that determines how and to whom the notification is sent. This refers to predefined notification profiles configured in your Playblocks system, such as "Immediate attention", "Low attention", or custom profiles that specify recipients, delivery channels (email, SMS, webhook), and timing preferences.

Notify - Example

{
        "type": "Notify",
        "name": "Notify admins",
        "parameters": {
        "subject": "Expert Shell login detected",
        "message": "Administrative access detected on critical system",
        "event_details": {
        "enabled": true,
        "event_details_fields": [
        {
        "name": "Administrator",
        "value": "{{step['Expert Shell login']['administrator']}}"
        },
        {
        "name": "Client IP",
        "value": "{{step['Expert Shell login']['client_ip']}}"
        }
        ]
        },
        "notification_profile": "Immediate attention"
        }
        }

Open Ticket

Creates tickets in external ticketing systems.

Open Ticket - Parameters Schema

{
        "subject": string | ParamRef (required),
        "description": string | ParamRef (required),
        "event_details": EventDetails (required),
        "ticket_types": TicketTypes (optional)
        }

Open Ticket - Parameters Detail

• subject (string/ParamRef, required): Ticket title/summary (max length is 300 characters)

• description (string/ParamRef, required): Ticket description/details (max length is 600 characters)

• event_details (object, required): Structured information to include with the ticket. This allows you to attach relevant context data to the ticket, such as affected systems, security indicators, timestamps, or any other information that will help ticket handlers understand and respond to the issue.

• ticket_types (object, optional): Ticket type per connector

  {
              "jira": string | ParamRef (optional),
              "service_now": string | ParamRef (optional)
              }

  • Valid service_now values: Low, Moderate, High, Critical

Open Ticket - Example

{
        "type": "Open Ticket",
        "name": "Create Security Incident",
        "parameters": {
        "subject": "Security Alert: {{step['Log Trigger']['event_type']}}",
        "description": "Automated security incident created from Playblocks",
        "event_details": {
        "enabled": true,
        "event_details_fields": [
        {
        "name": "Source IP",
        "value": "{{step['Log Trigger']['source_ip']}}"
        },
        {
        "name": "Severity",
        "value": "High"
        }
        ]
        },
        "ticket_types": {
        "jira": "Default",
        "service_now": "Moderate"
        }
        }
        }