38 lines
1.9 KiB
JSON
38 lines
1.9 KiB
JSON
{
|
|
"NotificationProvider": {
|
|
"filePath": "packages/modules/notification/src/models/notification-provider.ts",
|
|
"properties": {
|
|
"id": "The ID of the notification provider.",
|
|
"handle": "The handle of the notification provider",
|
|
"name": "The name of the notification provider",
|
|
"is_enabled": "Whether the notification provider is enabled.",
|
|
"channels": "The channels the notification provider can be used for. For example, `email`.",
|
|
"notifications": "The associated notifications.\n\n@expandable"
|
|
},
|
|
"deprecated": {
|
|
"is_deprecated": false
|
|
}
|
|
},
|
|
"Notification": {
|
|
"filePath": "packages/modules/notification/src/models/notification.ts",
|
|
"properties": {
|
|
"id": "The ID of the notification.",
|
|
"to": "The to of the notification",
|
|
"channel": "The channel of the notification. For example, `email`.",
|
|
"template": "The template of the notification. For example, if you're using a service like SendGrid, this would be the template ID of the notification.",
|
|
"data": "The data payload sent with the notification",
|
|
"trigger_type": "The event name, the workflow, or anything else that can help to identify what triggered the notification.",
|
|
"resource_id": "The ID of the resource this notification is for, if applicable.",
|
|
"resource_type": "The type of the resource this notification is for, if applicable. For example, `order`.",
|
|
"receiver_id": "The ID of the customer this notification is for, if applicable.",
|
|
"original_notification_id": "The ID of the original notification, in case this is a retried notification.",
|
|
"idempotency_key": "The idempotency key of the notification.",
|
|
"external_id": "The id of the notification in the external system.",
|
|
"provider": "The associated provider used to send the notification.\n\n@expandable",
|
|
"status": "The status of the notification"
|
|
},
|
|
"deprecated": {
|
|
"is_deprecated": false
|
|
}
|
|
}
|
|
} |