Skip to main content

Webhooks

Struct Webhooks 

Source
pub struct Webhooks { /* private fields */ }
Expand description

Verifies webhook signatures against a shared secret.

Implementations§

Source§

impl Webhooks

Source

pub fn new(secret: &str) -> Result<Self, WebhookVerificationError>

Create a new verifier from a webhook secret.

If the secret starts with "whsec_", the remainder is base64-decoded (standard alphabet) into the raw key bytes; otherwise the secret’s raw bytes are used directly.

Divergence from webhooks.py: the Python SDK decodes the secret lazily inside verify_signature; we decode eagerly here so an invalid whsec_ secret is surfaced at construction time.

Source

pub fn verify_signature( &self, payload: &[u8], headers: &WebhookHeaders, tolerance_secs: i64, now_unix: i64, ) -> Result<(), WebhookVerificationError>

Verify the signature of a webhook payload.

now_unix is the current time in Unix seconds (injected for testability; see Webhooks::verify for a variant that reads the system clock). tolerance_secs bounds how far in the past or future the webhook timestamp may be (default DEFAULT_TOLERANCE_SECS).

Source

pub fn verify( &self, payload: &[u8], id: &str, timestamp: &str, signature_header: &str, ) -> Result<(), WebhookVerificationError>

Convenience wrapper that reads the current system time and uses the default tolerance.

Source

pub fn unwrap( &self, payload: &[u8], headers: &WebhookHeaders, ) -> Result<WebhookEvent, WebhookVerificationError>

Verify the payload and parse it into a WebhookEvent.

Divergence from the parent shorthand: verification requires the webhook headers, so unwrap takes them explicitly (the Python unwrap(payload, headers, secret) does the same). Uses the system clock and default tolerance.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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