Send a custom notification - ION Manual

ION Notification System

ION has a notification system built into the application’s workflows, with both native notifications and notifications you can send through the ION API. For example, when you’re assigned to an approved issue disposition, you receive a toast notification while you’re using the application and a notification in the notifications tab. Toast notifications appear in the interface. ION checks for toast notifications every 30 seconds, so a toast can take up to 30 seconds to appear. To view all notifications in detail, go to the notification page by clicking the envelope icon and selecting Show all.

Send a custom notification

Use the dispatchNotification mutation to send custom notifications:

mutation notification($input:DispatchNotificationInput!) {
  dispatchNotification(input: $input) {
    response {
      messageId
    }
  }
}

Use these query variables:

{
  "input": {
    "userId": 3660,
    "notificationType": "WARNING",
    "description": "Purchase order versioned and PDF file generated. Please refresh.",
    "title": "PO Versioned & PDF Generated",
    "linkText": "This is the link",
    "path": "https://app-v2.buildwithion.com/"
  }
}

The query variables are:

• userId: The ID of the user you want to send the notification to.
• notificationType: The type of notification to dispatch. In this example, WARNING signifies a critical notification.
• description: A brief description of the notification’s content.
• title: The title of the notification, displayed in the toast notification.
• linkText: The text displayed as the link in the notification page, directing users to further details or actions.
• path: The URL path users go to when they click either the toast notification or the notification in the application.

Notification types

ION supports the following notification types:

• EXTERNAL (blue): Notifications originating from external systems, typically used for general updates.
• SIGNOFF (yellow): Notifications requiring user attention or signoff.
• WARNING (red): A critical event the user should be aware of.