•  Refresh
  • Tools
  •  
  • Expand All
  • Collapse All
  • Locales
  • Get File Link
  • Report Typo
  • Print
  • Export

Push Notifications: General Information

Push notifications are notifications in JSON format that are sent by Acumatica ERP to notification destinations when specific data changes occur in Acumatica ERP. External applications can receive the notifications and process them to retrieve the information about the changes.

In This Topic [Hide/Show]

Back to TopLearning Objectives

In this chapter, you will learn the following:

  • How to configure push notifications
  • Which requirements exist in Acumatica ERP for the data queries that are used by push notifications
  • Which push notification destinations you can use
  • Which format of push notifications is used by Acumatica ERP
  • How to process failed push notifications
  • How to include push notification configuration in a customization project

Back to TopApplicable Scenarios

You define push notifications in Acumatica ERP in the following scenarios:

  • You need to send notifications about changes in particular data.
  • You need to implement real-time synchronization of changes in the data in Acumatica ERP with the data in an external system.

Back to TopConfiguration of Push Notifications

To work with Acumatica ERP push notifications, you need to configure the following items:

  • The data query that defines the data for whose changes Acumatica ERP should send notifications
  • The destination to which Acumatica ERP should send notifications
  • The way the external application processes the notifications
  • The definition of the push notification in Acumatica ERP, which specifies the data query and the notification destination

The following diagram illustrates the sending of a push notification and shows the items that you need to configure to receive push notifications when changes occur.

Sending a push notification
Sending a push notification
To configure push notifications, you use the Push Notifications (SM302000) form. You can configure as many push notifications as you wish.

Back to TopData Query

The data query can be defined by either a generic inquiry or a built-in query definition (which is a data query defined in code). For details on generic inquiries, see Managing Generic Inquiries. For information on how to create a built-in query definition, see Push Notifications: To Create a Built-In Query Definition. You can define multiple queries for one notification destination.

The data query should adhere to the recommendations described in Push Notifications: Recommendations for the Data Queries.

Back to TopNotification Destination

The following predefined notification destinations are provided: webhook (HTTP address), message queue, SignalR hub, and commerce push destination. For more information on the predefined notification destinations, see Push Notifications: Destinations. You can also create your own destination type, as described in Push Notifications: To Create a Custom Destination Type.

Back to TopProcessing of the Notifications in the External Application

You should configure your external application so that it can process the notifications and extract the information about the data changes. Acumatica ERP sends notifications to notification destinations in JSON format. For details on the format of the notifications, see Push Notifications: Format. If your application watches notifications in the SignalR hub, you need to connect to the hub, as described in Push Notifications: To Connect to the SignalR Hub.

Back to TopDefinition of the Push Notification

In the definition of the push notification on the Push Notifications (SM302000) form, you specify the notification destination and the data queries for which the notifications should be sent. You can also specify particular fields that the system should track in the results of the data queries.

If an attribute is included in the list of fields that the system should track, the returned inserted and deleted rows contain null for the value of the attribute that was not changed. For details, see Push Notifications: Format.