Skip to main content

WebhookTrigger

Struct WebhookTrigger 

Source
pub struct WebhookTrigger {
    pub path: String,
    pub secret: Option<String>,
    pub required_fields: HashMap<String, String>,
    pub description: String,
}
Expand description

Configuration for an HTTP POST webhook trigger.

When an HTTP POST arrives at path, the JSON body is decoded and checked:

  1. If secret is set, the X-Hub-Signature-256 header must contain a valid HMAC-SHA256 signature of the raw body (pure-Rust implementation).
  2. All entries in required_fields must be present in the JSON object with the expected string values.

Real HTTP integration is the caller’s responsibility; see WebhookRouter.

Fields§

§path: String

URL path that activates this trigger (e.g. "/webhooks/ingest-ready").

§secret: Option<String>

Optional HMAC-SHA256 secret for signature verification.

§required_fields: HashMap<String, String>

JSON body fields that must match to fire the trigger.

§description: String

Optional description.

Implementations§

Source§

impl WebhookTrigger

Source

pub fn new(path: impl Into<String>) -> Self

Create a new webhook trigger for the given path.

Source

pub fn with_secret(self, secret: impl Into<String>) -> Self

Set an HMAC-SHA256 secret for signature verification.

Source

pub fn with_required_field( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Require a JSON body field to have a specific value.

Source

pub fn with_description(self, desc: impl Into<String>) -> Self

Set a human-readable description.

Source

pub fn verify_signature(&self, payload: &[u8], signature: &str) -> bool

Verify the HMAC-SHA256 signature of a raw payload.

signature is the hex-encoded digest (e.g. the value of the X-Hub-Signature-256 header without any sha256= prefix).

Returns true when the signature is valid or no secret is configured.

Source

pub fn body_matches(&self, body: &Value) -> bool

Check whether a parsed JSON body satisfies the required-fields filter.

Trait Implementations§

Source§

impl Clone for WebhookTrigger

Source§

fn clone(&self) -> WebhookTrigger

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WebhookTrigger

Source§

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

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<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