Enum WebhookError 

pub enum WebhookError {
    MissingHeader(String),
    MalformedPayload(String),
    InvalidSignature(String),
    ReplayDetected(String),
    Backend(String),
}

Why a webhook verification failed, classified so callers can map the variant onto an HTTP response code.

The inner String carries vendor-provided detail ("timestamp 123 is 412s old, max 300s", "signature byte mismatch at index 7", …) suitable for logs and error pages. Do not parse it; use the variant for branching.

HTTP mapping (enforced at the middleware layer, not here):

Variant	HTTP status	Safe to retry?
MissingHeader	400	No — fix the sender.
MalformedPayload	400	No — fix the sender.
InvalidSignature	401	No — wrong secret.
ReplayDetected	401	No — resend with new ts.
Backend	500	Yes, once.

Variants

MissingHeader(String)

A header the scheme requires is missing from the request. The inner string is the header name the plugin expected.

MalformedPayload(String)

A required header or body section exists but is syntactically malformed (e.g. Stripe’s t=...,v1=... comma-list fails to parse, Twilio’s URL can’t be reconstructed from the scheme + host + path triple).

InvalidSignature(String)

The HMAC comparison failed — either the body was mutated in flight, the signing secret on this side is wrong, or the request is an outright forgery. Indistinguishable from the plugin’s point of view.

ReplayDetected(String)

A valid-looking request is too old to accept (Stripe default: 5 minutes, Slack default: 5 minutes). Resending with a fresh timestamp would succeed, so this is distinct from InvalidSignature.

Backend(String)

The plugin itself could not complete verification because of a host-side fault (secret missing from config, clock skew probe failed, underlying crypto library returned an error the plugin couldn’t classify). Middleware MUST NOT leak this back to the sender as a signature failure.

Implementations

impl WebhookError

pub fn missing_header(name: impl Into<String>) -> Self

pub fn malformed(detail: impl Into<String>) -> Self

pub fn invalid_signature(detail: impl Into<String>) -> Self

pub fn replay(detail: impl Into<String>) -> Self

pub fn backend(detail: impl Into<String>) -> Self

pub fn message(&self) -> &str

Borrow the inner detail string, regardless of variant.

pub fn http_status(&self) -> u16

Recommended HTTP status code for this error. Middleware returning the response body MAY override — this is a hint, not a hard binding.

Trait Implementations

impl Clone for WebhookError

fn clone(&self) -> WebhookError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebhookError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebhookError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for WebhookError

fn fmt(&self, f: &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 PartialEq for WebhookError

fn eq(&self, other: &WebhookError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for WebhookError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for WebhookError

impl StructuralPartialEq for WebhookError