extraProperties
required |
object
|
nullableread only
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
id
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
creationTime
required |
string (date-time)
|
The date and time when this entity was created.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
creatorId
required |
string (uuid)
|
The ID of the user who created this entity.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lastModificationTime
required |
string (date-time)
|
The date and time when this entity was last modified.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lastModifierId
required |
string (uuid)
|
The ID of the user who last modified this entity.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isDeleted
required |
boolean
|
Indicates whether this entity has been deleted.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
deleterId
required |
string (uuid)
|
The ID of the user who deleted this entity, if it is deleted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
deletionTime
required |
string (date-time)
|
The date and time when this entity was deleted, if it is deleted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
name
required |
string
|
Destination name.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
description
required |
string
|
Optional description.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
type
required |
DestinationType
DestinationType |
The delivery transport type.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Webhook |
HTTP POST to a configured URL with HMAC signature headers. | Email |
Email delivery to the configured recipient addresses. | AmazonSqs |
Amazon Simple Queue Service (SQS) message delivery. | AzureServiceBusQueue |
Azure Service Bus Queue message delivery. | InApp |
In-app notification delivered in-process to connected clients on this instance. Suitable for real-time UI notifications (dropdown, popup, badge). | Slack |
Slack message delivery via Block Kit-formatted channel messages. Supports per-destination bot tokens for multi-workspace routing. | Sms |
SMS text message delivery to a single recipient phone number via the platform SMS sender. Opt-out compliance is enforced at send time, so an opted-out recipient is blocked before the carrier is contacted. |
|
configJson
required |
string
|
Type-specific configuration JSON.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
status
required |
DestinationStatus
DestinationStatus |
Current health status.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Default |
Destination has not been tested or is operating normally. | ConfigurationError |
Destination configuration is invalid (e.g., malformed URL, missing credentials). | ThrottlingWarning |
Destination is responding but rate-limiting or throttling requests. | ExternalServerError |
External server returned 5xx errors. | TimeoutError |
Delivery timed out waiting for response. | AuthError |
Authentication or authorization failure (401/403). | UnknownError |
An unclassified error occurred during delivery. |
|
lastErrorDetail
required |
string
|
Detail from the last error, if any.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lastTestedAtUtc
required |
string (date-time)
|
UTC timestamp of the last test or health check.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isEnabled
required |
boolean
|
Whether the destination is enabled.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
scope
required |
EntityScopeKind
EntityScopeKind |
Ownership scope of this destination: merchant, reseller, or tenant-wide (admin-owned).
Stamped server-side at creation from the creating caller's operating context and never
settable through the create or update DTO.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Merchant |
Row applies to a single merchant. MerchantId must be non-null. | Reseller |
Row applies to a reseller and (by entity-specific semantics) its descendants. ResellerId must be non-null. | Tenant |
Row applies tenant-wide. Visible only to unscoped (admin) callers. |
|
resellerId
required |
string (uuid)
|
Owning reseller, set only for a reseller-scoped destination.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
merchantId
required |
string (uuid)
|
Owning merchant, set only for a merchant-scoped destination.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
suppression
required |
DestinationSuppressionStateDto
DestinationSuppressionStateDto |
Durable suppression state for this destination's endpoint, or `null` when the endpoint has
never failed (or when the transport type has no endpoint concept).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
concurrencyStamp
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
tenantId
required |
string (uuid)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
entityVersion
required |
integer (int32)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|