92 lines
2.7 KiB
YAML
92 lines
2.7 KiB
YAML
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:
|
|
- created_at
|
|
- customer_id
|
|
- data
|
|
- event_name
|
|
- id
|
|
- parent_id
|
|
- provider_id
|
|
- resource_type
|
|
- resource_id
|
|
- to
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
description: The notification's ID
|
|
type: string
|
|
example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
|
|
event_name:
|
|
description: The name of the event that the notification was sent for.
|
|
nullable: true
|
|
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.
|
|
nullable: true
|
|
type: string
|
|
example: cus_01G2SG30J8C85S4A5CHM2S1NS2
|
|
customer:
|
|
description: A customer object. Available if the relation `customer` is expanded.
|
|
nullable: true
|
|
$ref: ./Customer.yaml
|
|
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: {}
|
|
parent_id:
|
|
description: The notification's parent ID
|
|
nullable: true
|
|
type: string
|
|
example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
|
|
parent_notification:
|
|
description: Available if the relation `parent_notification` is expanded.
|
|
nullable: true
|
|
type: object
|
|
resends:
|
|
description: >-
|
|
The resends that have been completed after the original Notification.
|
|
Available if the relation `resends` is expanded.
|
|
type: array
|
|
items:
|
|
type: object
|
|
provider_id:
|
|
description: The id of the Notification Provider that handles the Notification.
|
|
nullable: true
|
|
type: string
|
|
example: sengrid
|
|
provider:
|
|
description: Available if the relation `provider` is expanded.
|
|
nullable: true
|
|
$ref: ./NotificationProvider.yaml
|
|
created_at:
|
|
description: The date with timezone at which the resource was created.
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
description: The date with timezone at which the resource was updated.
|
|
type: string
|
|
format: date-time
|