Struct WebhookRegistration 

pub struct WebhookRegistration {
    pub topic: WebhookTopic,
    pub delivery_method: WebhookDeliveryMethod,
    pub include_fields: Option<Vec<String>>,
    pub metafield_namespaces: Option<Vec<String>>,
    pub filter: Option<String>,
    /* private fields */
}

Represents a webhook registration configuration.

This struct holds the configuration for a webhook subscription, including the topic, delivery method, optional filtering options, and an optional handler for processing incoming webhooks.

Fields

• topic: The webhook topic to subscribe to
• delivery_method: How the webhook should be delivered (HTTP, EventBridge, or Pub/Sub)
• include_fields: Optional list of fields to include in the webhook payload
• metafield_namespaces: Optional list of metafield namespaces to include
• filter: Optional filter string (e.g., “status:active”)
• handler: Optional handler for processing incoming webhooks

Example

use shopify_sdk::webhooks::{WebhookRegistration, WebhookRegistrationBuilder, WebhookDeliveryMethod};
use shopify_sdk::rest::resources::v2025_10::common::WebhookTopic;

let registration = WebhookRegistrationBuilder::new(
    WebhookTopic::OrdersCreate,
    WebhookDeliveryMethod::Http {
        uri: "https://example.com/webhooks/orders".to_string(),
    },
)
.build();

assert!(matches!(
    registration.delivery_method,
    WebhookDeliveryMethod::Http { .. }
));

Fields

topic: WebhookTopic

The webhook topic to subscribe to.

delivery_method: WebhookDeliveryMethod

The delivery method for the webhook.

Determines how webhooks are delivered: via HTTP callback, Amazon EventBridge, or Google Cloud Pub/Sub.

include_fields: Option<Vec<String>>

Optional list of fields to include in the webhook payload.

When specified, only these fields will be included in the webhook payload.

metafield_namespaces: Option<Vec<String>>

Optional list of metafield namespaces to include in the webhook payload.

filter: Option<String>

Optional filter string for the webhook subscription.

Example: “status:active”

Trait Implementations

impl Debug for WebhookRegistration

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

Formats the value using the given formatter.