Struct CreateWebhookEndpoint

pub struct CreateWebhookEndpoint { /* private fields */ }

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

Implementations

impl CreateWebhookEndpoint

pub fn new( enabled_events: impl Into<Vec<CreateWebhookEndpointEnabledEvents>>, url: impl Into<String>, ) -> Self

Construct a new CreateWebhookEndpoint.

pub fn api_version(self, api_version: impl Into<ApiVersion>) -> Self

Events sent to this endpoint will be generated with this Stripe Version instead of your account’s default Stripe Version.

pub fn connect(self, connect: impl Into<bool>) -> Self

Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.

pub fn description(self, description: impl Into<String>) -> Self

An optional description of what the webhook is used for.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

impl CreateWebhookEndpoint

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

Trait Implementations

impl Clone for CreateWebhookEndpoint

fn clone(&self) -> CreateWebhookEndpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateWebhookEndpoint

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

Formats the value using the given formatter.

impl Serialize for CreateWebhookEndpoint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for CreateWebhookEndpoint

type Output = WebhookEndpoint

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.