Struct WebhookRequest 

pub struct WebhookRequest { /* private fields */ }

Represents an incoming webhook request from Shopify.

This struct holds the raw request body and headers needed for verification. The body is stored as raw bytes to preserve the exact payload for HMAC computation.

Example

use shopify_sdk::webhooks::WebhookRequest;

let request = WebhookRequest::new(
    b"raw body bytes".to_vec(),
    "hmac-signature".to_string(),
    Some("orders/create".to_string()),
    Some("example.myshopify.com".to_string()),
    Some("2025-10".to_string()),
    Some("webhook-123".to_string()),
);

assert_eq!(request.body(), b"raw body bytes");
assert_eq!(request.hmac_header(), "hmac-signature");

Implementations

impl WebhookRequest

pub fn new( body: Vec<u8>, hmac_header: String, topic: Option<String>, shop_domain: Option<String>, api_version: Option<String>, webhook_id: Option<String>, ) -> Self

Creates a new webhook request with the given body and headers.

Arguments

• body - Raw request body as bytes
• hmac_header - Value of the X-Shopify-Hmac-SHA256 header
• topic - Value of the X-Shopify-Topic header (optional)
• shop_domain - Value of the X-Shopify-Shop-Domain header (optional)
• api_version - Value of the X-Shopify-API-Version header (optional)
• webhook_id - Value of the X-Shopify-Webhook-Id header (optional)

pub fn body(&self) -> &[u8]

Returns the raw request body as a byte slice.

pub fn hmac_header(&self) -> &str

Returns the HMAC signature header value.

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

Returns the topic header value, if present.

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

Returns the shop domain header value, if present.

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

Returns the API version header value, if present.

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

Returns the webhook ID header value, if present.

Trait Implementations

impl Clone for WebhookRequest

fn clone(&self) -> WebhookRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebhookRequest

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

Formats the value using the given formatter.