Struct WebhookProcessor

pub struct WebhookProcessor { /* private fields */ }

A webhook processor that handles signature verification and event dispatching

This struct provides a convenient way to process webhook events with optional signature verification.

Examples

use discourse_webhooks::WebhookProcessor;

// Without signature verification
let processor = WebhookProcessor::new();

// With signature verification
let processor = WebhookProcessor::new()
    .with_secret("your_webhook_secret");

Implementations

impl WebhookProcessor

pub fn new() -> Self

Create a new webhook processor with default settings

By default, signature verification is disabled.

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

Enable signature verification with the provided secret

Arguments

• secret - The shared secret key for HMAC verification

pub fn without_signature_verification(self) -> Self

Disable signature verification

This can be useful for development or when webhooks are received through a trusted channel.

pub fn verifies_signatures(&self) -> bool

Check if signature verification is enabled

pub fn secret(&self) -> Option<&str>

Get the configured secret (if any)

pub fn process<H: WebhookEventHandler>( &self, handler: &mut H, event_type: &str, payload: &str, signature: Option<&str>, ) -> Result<(), H::Error>

Process a webhook from a string payload

Arguments

• handler - Mutable reference to an event handler
• event_type - The type of event (e.g., “topic_created”)
• payload - The raw JSON payload as a string
• signature - Optional signature header for verification

pub fn process_json<H: WebhookEventHandler>( &self, handler: &mut H, event_type: &str, payload: Value, signature: Option<&str>, ) -> Result<(), H::Error>

Process a webhook from a JSON value

Arguments

• handler - Mutable reference to an event handler
• event_type - The type of event (e.g., “topic_created”)
• payload - The JSON payload as a serde_json::Value
• signature - Optional signature header for verification

Trait Implementations

impl Clone for WebhookProcessor

fn clone(&self) -> WebhookProcessor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebhookProcessor

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

Formats the value using the given formatter.

impl Default for WebhookProcessor

fn default() -> Self

Returns the “default value” for a type.