M3m3ter-com
Notifications

Retrieve Notification

Changed on

Retrieve the details of a specific Notification using its UUID. Includes the Event the Notification is based on, and any calculation referencing the Event's field and which defines further conditions that must be met to trigger the Notification when the Event occurs.

get/organizations/{orgId}/notifications/configurations/{id}

Request

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

idstring required

The unique identifier (UUID) of the Notification to retrieve.

Response

Returns the Notification

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
dtCreatedstring date-time

The DateTime when this item was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when this item was last modified (in ISO-8601 format).

createdBystring

The ID of the user who created this item.

lastModifiedBystring

The ID of the user who last modified this item.

namestring required

The name of the Notification.

descriptionstring required

The description for the Notification providing a brief overview of its purpose and functionality.

activeboolean

A Boolean flag indicating whether or not the Notification is active.

  • TRUE - active Notification.
  • FALSE - inactive Notification.
alwaysFireEventboolean

A Boolean flag indicating whether the Notification is always triggered, regardless of other conditions and omitting reference to any calculation. This means the Notification will be triggered simply by the Event it is based on occurring and with no further conditions having to be met.

  • TRUE - the Notification is always triggered and omits any reference to the calculation to check for other conditions being true before triggering the Notification.
  • FALSE - the Notification is only triggered when the Event it is based on occurs and any calculation is checked and all conditions defined by the calculation are met.
eventNamestring

The name of the Event that the Notification is based on. When this Event occurs and the calculation evaluates to True, the Notification is triggered.

Note: If the Notification is set to always fire, then the Notification will always be sent when the Event it is based on occurs, and without any other conditions defined by a calculation having to be met.

calculationstring

A logical expression that that is evaluated to a Boolean. If it evaluates as True, a Notification for the Event is created and sent to the configured destination. Calculations can reference numeric, string, and boolean Event fields.

See Creating Calculations in the m3ter documentation for more information.

codestring required

The short code for the Notification.

Example response

{
  "name": "Commitment has under 10% remaining",
  "description": "Commitment amount fell below 10%",
  "active": true,
  "eventName": "configuration.commitment.updated",
  "calculation": "(new.amountSpent >= ((new.amount*90)/100)) \nAND ((old.amountSpent <= ((old.amount*90)/100)) OR (old.amountSpent == null))",
  "code": "commitment_under_10_percent"
}

Changes

  • 85c514abc692Revision changes
    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

  • 9f9e5f3dbde7Revision changes
    • breaking

      the response property //////// became optional for the status

    • breaking

      the response property //// became optional for the status