Skip to main content

WebhookDeliveryMethod

Enum WebhookDeliveryMethod 

Source
pub enum WebhookDeliveryMethod {
    Http {
        uri: String,
    },
    EventBridge {
        arn: String,
    },
    PubSub {
        project_id: String,
        topic_id: String,
    },
}
Expand description

Represents the delivery method for a webhook subscription.

Webhooks can be delivered via HTTP callback, Amazon EventBridge, or Google Cloud Pub/Sub.

§Variants

  • Http: Delivers webhooks to an HTTP/HTTPS endpoint
  • EventBridge: Delivers webhooks to Amazon EventBridge
  • PubSub: Delivers webhooks to Google Cloud Pub/Sub

§Example

use shopify_sdk::webhooks::WebhookDeliveryMethod;

// HTTP delivery
let http = WebhookDeliveryMethod::Http {
    uri: "https://example.com/webhooks".to_string(),
};

// Amazon EventBridge delivery
let eventbridge = WebhookDeliveryMethod::EventBridge {
    arn: "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/12345/my-source".to_string(),
};

// Google Cloud Pub/Sub delivery
let pubsub = WebhookDeliveryMethod::PubSub {
    project_id: "my-project".to_string(),
    topic_id: "shopify-webhooks".to_string(),
};

Variants§

§

Http

HTTP/HTTPS webhook delivery.

Webhooks are delivered via HTTP POST to the specified URI.

Fields

§uri: String

The full HTTPS URI for webhook delivery.

§

EventBridge

Amazon EventBridge webhook delivery.

Webhooks are delivered to an Amazon EventBridge event source. The ARN format is typically: arn:aws:events:{region}::event-source/aws.partner/shopify.com/{org}/{event_source}

Fields

§arn: String

The Amazon Resource Name (ARN) for the EventBridge event source.

§

PubSub

Google Cloud Pub/Sub webhook delivery.

Webhooks are delivered to a Google Cloud Pub/Sub topic.

Fields

§project_id: String

The Google Cloud project ID.

§topic_id: String

The Pub/Sub topic ID.

Trait Implementations§

Source§

impl Clone for WebhookDeliveryMethod

Source§

fn clone(&self) -> WebhookDeliveryMethod

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WebhookDeliveryMethod

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for WebhookDeliveryMethod

Source§

fn eq(&self, other: &WebhookDeliveryMethod) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for WebhookDeliveryMethod

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<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> 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> 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