Class HttpInvitationDeliveryOptions
Namespace: Cephalon.MultiTenancy.Governance.HttpDelivery.Configuration
Assembly: Cephalon.MultiTenancy.Governance.HttpDelivery.dll
Configures HTTP webhook delivery for tenant invitations dispatched by the governance companion pack.
public sealed class HttpInvitationDeliveryOptionsInheritance
Section titled “Inheritance”object ← HttpInvitationDeliveryOptions
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Remarks
Section titled “Remarks”The HTTP sender queues or sends a delivery request to a configured endpoint. It does not guarantee final recipient delivery and does not encode product-specific email, SMS, chat, or identity-provider semantics.
Constructors
Section titled “Constructors”HttpInvitationDeliveryOptions()
Section titled “ HttpInvitationDeliveryOptions()”Creates HTTP invitation delivery options with the default sender identifier and timeout.
public HttpInvitationDeliveryOptions()Properties
Section titled “Properties”EnableIdempotencyHeader
Section titled “ EnableIdempotencyHeader”Gets or sets a value indicating whether an idempotency key header should be added to delivery requests.
public bool EnableIdempotencyHeader { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”The key stays stable across retry attempts for the same dispatch and helps receivers de-duplicate side effects.
Enabled
Section titled “ Enabled”Gets or sets a value indicating whether the HTTP invitation sender should be registered.
public bool Enabled { get; set; }Property Value
Section titled “Property Value”Endpoint
Section titled “ Endpoint”Gets or sets the absolute HTTP endpoint that receives invitation delivery payloads.
public string? Endpoint { get; set; }Property Value
Section titled “Property Value”ExpectedStatusCodes
Section titled “ ExpectedStatusCodes”Gets or sets explicit response status codes that indicate the webhook accepted the dispatch.
public IReadOnlyList<int> ExpectedStatusCodes { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”When empty, any successful 2xx response is accepted.
Headers
Section titled “ Headers”Gets or sets additional HTTP headers added to every delivery request.
public IReadOnlyDictionary<string, string> Headers { get; set; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
IdempotencyHeaderName
Section titled “ IdempotencyHeaderName”Gets or sets the request header that carries the delivery idempotency key.
public string IdempotencyHeaderName { get; set; }Property Value
Section titled “Property Value”IdempotencyMetadataKey
Section titled “ IdempotencyMetadataKey”Gets or sets the dispatch metadata key that can supply a caller-owned idempotency key.
public string IdempotencyMetadataKey { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”When the metadata key is absent or empty, the sender derives a stable hashed key from the tenant, invitation, channel, and sender identifiers. Caller-supplied values that are too long or unsafe for HTTP headers are hashed before being sent.
IncludeInvitationMetadata
Section titled “ IncludeInvitationMetadata”Gets or sets a value indicating whether invitation metadata should be included in the webhook payload.
public bool IncludeInvitationMetadata { get; set; }Property Value
Section titled “Property Value”IncludeRequestMetadata
Section titled “ IncludeRequestMetadata”Gets or sets a value indicating whether dispatch request metadata should be included in the webhook payload.
public bool IncludeRequestMetadata { get; set; }Property Value
Section titled “Property Value”IncludeResponseBodyInMetadata
Section titled “ IncludeResponseBodyInMetadata”Gets or sets a value indicating whether a bounded response body excerpt should be copied into sender metadata.
public bool IncludeResponseBodyInMetadata { get; set; }Property Value
Section titled “Property Value”MaxAttempts
Section titled “ MaxAttempts”Gets or sets the total number of HTTP dispatch attempts for transient delivery failures.
public int MaxAttempts { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”The value is clamped to the supported range of 1 through 10. The default preserves single-attempt behavior.
Method
Section titled “ Method”Gets or sets the HTTP method used for delivery requests.
public string Method { get; set; }Property Value
Section titled “Property Value”ProviderMessageIdHeaderName
Section titled “ ProviderMessageIdHeaderName”Gets or sets the response header that contains the provider message identifier.
public string? ProviderMessageIdHeaderName { get; set; }Property Value
Section titled “Property Value”ResponseBodyMetadataLimit
Section titled “ ResponseBodyMetadataLimit”Gets or sets the maximum response body characters copied into sender metadata when enabled.
public int ResponseBodyMetadataLimit { get; set; }Property Value
Section titled “Property Value”RetryDelayMilliseconds
Section titled “ RetryDelayMilliseconds”Gets or sets the fixed delay, in milliseconds, between retry attempts.
public int RetryDelayMilliseconds { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”The value is clamped to the supported range of 0 through 60000 milliseconds.
RetryStatusCodes
Section titled “ RetryStatusCodes”Gets or sets response status codes that should be retried when the dispatch has attempts remaining.
public IReadOnlyList<int> RetryStatusCodes { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”The default covers common transient HTTP responses: 408, 429, 500, 502, 503, and 504.
RetryTransportFailures
Section titled “ RetryTransportFailures”Gets or sets a value indicating whether transient transport failures should be retried when attempts remain.
public bool RetryTransportFailures { get; set; }Property Value
Section titled “Property Value”SenderId
Section titled “ SenderId”Gets or sets the sender identifier used by TenantInvitationDeliveryRequest.SenderId.
public string SenderId { get; set; }Property Value
Section titled “Property Value”SignatureHeaderName
Section titled “ SignatureHeaderName”Gets or sets the request header that carries the webhook signature.
public string SignatureHeaderName { get; set; }Property Value
Section titled “Property Value”SignatureKeyIdHeaderName
Section titled “ SignatureKeyIdHeaderName”Gets or sets the request header that carries the optional signing key identifier.
public string SignatureKeyIdHeaderName { get; set; }Property Value
Section titled “Property Value”SignatureTimestampHeaderName
Section titled “ SignatureTimestampHeaderName”Gets or sets the request header that carries the Unix timestamp included in the webhook signature.
public string SignatureTimestampHeaderName { get; set; }Property Value
Section titled “Property Value”SigningKeyId
Section titled “ SigningKeyId”Gets or sets an optional key identifier sent with signed webhook requests.
public string? SigningKeyId { get; set; }Property Value
Section titled “Property Value”SigningSecret
Section titled “ SigningSecret”Gets or sets the shared secret used to sign webhook payloads with HMAC-SHA256.
public string? SigningSecret { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”When empty, the sender does not add Cephalon webhook signature headers.
SupportedChannels
Section titled “ SupportedChannels”Gets or sets delivery channels accepted by this sender.
public IReadOnlyList<string> SupportedChannels { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”When empty, the sender accepts every requested channel.
TimeoutSeconds
Section titled “ TimeoutSeconds”Gets or sets the maximum time allowed for the HTTP delivery request.
public int TimeoutSeconds { get; set; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”FromConfiguration(IConfiguration, string)
Section titled “ FromConfiguration(IConfiguration, string)”Binds HTTP invitation delivery options from configuration.
public static HttpInvitationDeliveryOptions FromConfiguration(IConfiguration configuration, string sectionPath = "Engine")Parameters
Section titled “Parameters”configuration IConfiguration
The application configuration root.
sectionPath string
The configuration section path that contains the engine settings. The default is Engine.
Returns
Section titled “Returns”The bound HTTP invitation delivery options.