Struct WebhookContext 

pub struct WebhookContext { /* private fields */ }

Represents verified webhook metadata after successful signature verification.

This struct is returned by verify_webhook and contains the parsed headers from a verified webhook request. It provides both the parsed topic enum (when the topic is a known value) and the raw topic string (always available).

Example

use shopify_sdk::webhooks::{WebhookRequest, verify_webhook, WebhookContext};
use shopify_sdk::webhooks::WebhookTopic;
use shopify_sdk::{ShopifyConfig, ApiKey, ApiSecretKey};
use shopify_sdk::auth::oauth::hmac::compute_signature_base64;

let config = ShopifyConfig::builder()
    .api_key(ApiKey::new("key").unwrap())
    .api_secret_key(ApiSecretKey::new("secret").unwrap())
    .build()
    .unwrap();

let body = b"test";
let hmac = compute_signature_base64(body, "secret");
let request = WebhookRequest::new(
    body.to_vec(),
    hmac,
    Some("orders/create".to_string()),
    Some("example.myshopify.com".to_string()),
    None,
    None,
);

let context = verify_webhook(&config, &request).unwrap();
assert_eq!(context.topic(), Some(WebhookTopic::OrdersCreate));
assert_eq!(context.topic_raw(), "orders/create");

Implementations

impl WebhookContext

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

Returns the parsed webhook topic enum, if the topic is a known value.

Returns None for unknown or custom topics.

pub fn topic_raw(&self) -> &str

Returns the raw topic string as received in the header.

This is always available, even for unknown or custom topics.

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

Returns the shop domain, if present in the webhook headers.

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

Returns the API version, if present in the webhook headers.

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

Returns the webhook ID, if present in the webhook headers.

Trait Implementations

impl Clone for WebhookContext

fn clone(&self) -> WebhookContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebhookContext

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

Formats the value using the given formatter.

impl PartialEq for WebhookContext

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