title: Notification
description: >-
  Notifications a communications sent via Notification Providers as a reaction
  to internal events such as `order.placed`. Notifications can be used to show a
  chronological timeline for communications sent to a Customer regarding an
  Order, and enables resends.
type: object
required:
  - resource_type
  - resource_id
  - to
properties:
  id:
    type: string
    description: The notification's ID
    example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
  event_name:
    description: The name of the event that the notification was sent for.
    type: string
    example: order.placed
  resource_type:
    description: The type of resource that the Notification refers to.
    type: string
    example: order
  resource_id:
    description: The ID of the resource that the Notification refers to.
    type: string
    example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
  customer_id:
    description: The ID of the Customer that the Notification was sent to.
    type: string
    example: cus_01G2SG30J8C85S4A5CHM2S1NS2
  customer:
    description: A customer object. Available if the relation `customer` is expanded.
    type: object
  to:
    description: >-
      The address that the Notification was sent to. This will usually be an
      email address, but represent other addresses such as a chat bot user id
    type: string
    example: user@example.com
  data:
    description: >-
      The data that the Notification was sent with. This contains all the data
      necessary for the Notification Provider to initiate a resend.
    type: object
    example: {}
  resends:
    description: The resends that have been completed after the original Notification.
    type: array
    items:
      $ref: ./NotificationResend.yaml
  provider_id:
    description: The id of the Notification Provider that handles the Notification.
    type: string
    example: sengrid
  provider:
    description: Available if the relation `provider` is expanded.
    $ref: ./NotificationProvider.yaml
  created_at:
    type: string
    description: The date with timezone at which the resource was created.
    format: date-time
  updated_at:
    type: string
    description: The date with timezone at which the resource was updated.
    format: date-time