chore(docs): Updated API Reference (v2) (#9148)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-09-18 07:13:51 +00:00
committed by GitHub
parent a63f6910d0
commit 56ee4d6aad
254 changed files with 6349 additions and 5461 deletions

View File

@@ -16,48 +16,57 @@ properties:
to:
type: string
title: to
description: The notification's to.
description: >-
Where to send the notification to. For example, if `channel` is `email`,
this can be an email number.
channel:
type: string
title: channel
description: The notification's channel.
description: Through which channel is the notification sent through.
example: email
template:
type: string
title: template
description: The notification's template.
description: >-
The ID of the template in a third-party service used as the notification's
shape.
data:
type: object
description: The notification's data.
description: Data payload to send with the notification.
trigger_type:
type: string
title: trigger_type
description: The notification's trigger type.
description: What triggered this notification.
example: order.created
resource_id:
type: string
title: resource_id
description: The notification's resource id.
description: >-
The ID of the associated resource. For example, if the notification was
triggered because an order was created, this would be the ID of the order.
resource_type:
type: string
title: resource_type
description: The notification's resource type.
description: The type of the resource that triggered the notification.
example: order
receiver_id:
type: string
title: receiver_id
description: The notification's receiver id.
description: The ID of the user or customer that's receiving this notification.
original_notification_id:
type: string
title: original_notification_id
description: The notification's original notification id.
description: The ID of the original notification, if this notification is resent.
external_id:
type: string
title: external_id
description: The notification's external id.
description: The ID of the notification in an external or third-party system.
provider_id:
type: string
title: provider_id
description: The notification's provider id.
description: The ID of the provider used to send the notification.
created_at:
type: string
format: date-time
title: created_at
description: The notification's created at.
description: The date the notification was created.