Enum WebhookVerificationError 

pub enum WebhookVerificationError {
    MissingHeaders,
    InvalidTimestampFormat,
    TimestampTooOld,
    TimestampTooNew,
    SignatureMismatch,
    InvalidSecret(String),
    InvalidPayload(String),
}

Errors produced while verifying a webhook signature.

This mirrors the messages raised by _exceptions.py::InvalidWebhookSignatureError in openai-python.

Variants

MissingHeaders

One of the webhook-id/webhook-timestamp/webhook-signature headers is missing.

InvalidTimestampFormat

The webhook-timestamp header was not a valid integer.

TimestampTooOld

The webhook is older than the allowed tolerance (replay protection).

TimestampTooNew

The webhook timestamp is further in the future than the tolerance.

SignatureMismatch

None of the provided signatures matched the expected signature.

InvalidSecret(String)

The whsec_ secret could not be base64-decoded.

InvalidPayload(String)

The payload could not be parsed as JSON (only used by Webhooks::unwrap).

Trait Implementations

impl Debug for WebhookVerificationError

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

Formats the value using the given formatter.

impl Display for WebhookVerificationError

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

Formats the value using the given formatter.

impl Eq for WebhookVerificationError

impl Error for WebhookVerificationError

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 WebhookVerificationError

fn eq(&self, other: &WebhookVerificationError) -> 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 StructuralPartialEq for WebhookVerificationError