Enum WebhookError 

#[non_exhaustive]
pub enum WebhookError {
    MissingSignature,
    InvalidSignature(String),
    SignatureVerificationFailed,
    TimestampExpired {
        received: i64,
        now: i64,
        tolerance: u64,
    },
    MissingTimestamp,
    MissingSecret(String),
    UnknownProvider(String),
    UnknownEvent(String),
    InvalidPayload(String),
    HandlerFailed(String),
    Database(String),
    Condition(String),
    Mapping(String),
    ProviderNotConfigured(String),
    Configuration(String),
}

Errors that can occur during webhook request processing.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MissingSignature

The incoming request did not include the expected signature header for the provider.

InvalidSignature(String)

The signature header was present but could not be parsed according to the provider’s format. The inner string contains a description of the parse failure.

SignatureVerificationFailed

The computed HMAC or asymmetric signature did not match the value in the request header.

TimestampExpired

The webhook request timestamp is outside the configured replay-protection tolerance window.

Fields

received: i64

Unix timestamp (seconds) extracted from the request.

now: i64

Unix timestamp (seconds) at the time of verification.

tolerance: u64

Maximum allowed age of a request in seconds before it is rejected.

MissingTimestamp

The provider requires a timestamp header for replay protection, but none was present.

MissingSecret(String)

The secret named in the configuration could not be retrieved from the secret provider. The inner string is the secret name that was not found.

UnknownProvider(String)

The request arrived for a provider name that is not registered in the ProviderRegistry. The inner string is the unrecognised provider name.

UnknownEvent(String)

The event type extracted from the payload has no corresponding handler in the configuration. The inner string is the unrecognised event type.

InvalidPayload(String)

The request body could not be deserialised as a valid JSON payload. The inner string is the serde_json error message.

HandlerFailed(String)

The database function called by the event handler returned an error or panicked. The inner string contains the handler’s error message.

Database(String)

A sqlx database operation failed during transaction management or idempotency checking. The inner string is the sqlx error message.

Condition(String)

Evaluation of a configured conditional expression failed. The inner string describes the evaluation error.

Mapping(String)

A field mapping from the webhook payload to a function parameter failed. The inner string describes which mapping could not be applied.

ProviderNotConfigured(String)

A webhook was received for a provider that has no entry in the active configuration. The inner string is the provider name.

Configuration(String)

A configuration field contains an invalid value. The inner string describes the validation failure.

Trait Implementations

impl Debug for WebhookError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for WebhookError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for WebhookError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for WebhookError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for WebhookError

fn from(err: Error) -> Self

Converts to this type from the input type.