Notification

id string

Unique identifier for the Notification object in string format.

Example: 1

type string

Type of object.

Default value: notification

Example: notification

attributes object

Notification attributes.

id integer

Unique identifier for the Notification object.

Example: 1

organization_id integer

Unique identifier for the Organization object.

Example: 1

name string

Unique name for the type of notification.

Example: mapping_required

data object nullable

Notification data used to capture the extra notification details different for each notification type or name.

Example: {"line_item":"gross_sales","jeti_label":"Gross Sales"}

created_at string

Date and time when the notification was created.

Example: 2024-06-06T13:47:41.491Z

ignored_at string nullable

Date and time when the notification was ignored. It is null if the notification is not ignored.

Example: 2024-06-06T13:47:41.491Z

resolved_at string nullable

Date and time when the notification was resolved. It is null if the notification is not resolved.

Example: 2024-06-06T13:47:41.491Z

organization_name string

Name of the organization

type string

Name of the notification in title case.

Example: Mapping Required

state string

State of the notification. It can be 'Pending', 'Ignored', or 'Resolved'. A notification is in 'Pending' state when it is created. It is in 'Ignored' state when resolved_at is null. It is in 'Resolved' state when resolved_at is not null.

Example: Pending

formatted_created_at string

Formatted created_at date and time in the organization's timezone.

Example: 2024-06-06 09:47:41 EDT

issue_details string

Issue details in HTML format.

Example: <span>Stripe Balance is not mapped</span>

resolve_actions string

Issue details in HTML format.

Example: <p>Reconnect the connection</p>

Notification

{
  "id": "1",
  "type": "notification",
  "attributes": {
    "id": 1,
    "organization_id": 1,
    "name": "mapping_required",
    "data": {
      "line_item": "gross_sales",
      "jeti_label": "Gross Sales"
    },
    "created_at": "2024-06-06T13:47:41.491Z",
    "ignored_at": "2024-06-06T13:47:41.491Z",
    "resolved_at": "2024-06-06T13:47:41.491Z",
    "organization_name": "string",
    "type": "Mapping Required",
    "state": "Pending",
    "formatted_created_at": "2024-06-06 09:47:41 EDT",
    "issue_details": "<span>Stripe Balance is not mapped</span>",
    "resolve_actions": "<p>Reconnect the connection</p>"
  }
}