Skip to main content

WebhookError

Enum WebhookError 

Source
#[non_exhaustive]
pub enum WebhookError { InvalidSignature, MissingSignature { header: String, }, TimestampExpired { age_seconds: u64, max_seconds: u64, }, TimestampFuture { future_seconds: u64, }, DuplicateEvent { event_id: String, }, UnknownEvent { event_type: String, }, ProviderNotConfigured { provider: String, }, PayloadError { message: String, }, IdempotencyError { message: String, }, }
Expand description

Errors that occur while receiving and validating inbound webhook requests.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

InvalidSignature

The HMAC signature on the webhook payload does not match the expected value for the shared secret.

This can indicate an invalid secret, payload tampering, or a replay from a different provider.

§

MissingSignature

The expected signature header was absent from the incoming request.

Fields

§header: String

Name of the HTTP header that was expected but not present.

§

TimestampExpired

The webhook timestamp is older than the configured replay-window, indicating a replay attack or severe clock skew.

Fields

§age_seconds: u64

Age of the webhook event in seconds.

§max_seconds: u64

Maximum allowed age in seconds.

§

TimestampFuture

The webhook timestamp is further in the future than clock skew allows, suggesting a pre-generated or tampered request.

Fields

§future_seconds: u64

Number of seconds the timestamp is ahead of the server clock.

§

DuplicateEvent

An event with this identifier has already been successfully processed.

The event should be acknowledged (2xx) and then discarded.

Fields

§event_id: String

Identifier of the duplicate event.

§

UnknownEvent

The event’s type field does not correspond to any registered handler.

Fields

§event_type: String

The unrecognised event type string.

§

ProviderNotConfigured

A webhook was received from a provider that has not been configured in fraiseql.toml.

Fields

§provider: String

Name of the unconfigured provider.

§

PayloadError

The webhook request body could not be parsed (invalid JSON, unexpected schema, etc.).

The raw error message is kept server-side and a generic response is returned to the caller.

Fields

§message: String

Description of the parse failure (server-side only).

§

IdempotencyError

The idempotency check (deduplication store lookup or write) failed.

Fields

§message: String

Description of the idempotency failure.

Implementations§

Source§

impl WebhookError

Source

pub const fn error_code(&self) -> &'static str

Returns a short, stable error code string suitable for API responses and structured logging.

Trait Implementations§

Source§

impl Debug for WebhookError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for WebhookError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for WebhookError

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<WebhookError> for RuntimeError

Source§

fn from(source: WebhookError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more