Struct stripe::WebhookEndpoint [−][src]
The resource representing a Stripe "NotificationWebhookEndpoint".
For more details see https://stripe.com/docs/api/webhook_endpoints/object.
Fields
id: WebhookEndpointId
Unique identifier for the object.
api_version: Option<ApiVersion>
The API version events are rendered as for this webhook endpoint.
application: Option<String>
The ID of the associated Connect application.
created: Option<Timestamp>
Time at which the object was created.
Measured in seconds since the Unix epoch.
deleted: bool
description: Option<String>
An optional description of what the webhook is used for.
enabled_events: Option<Vec<EventFilter>>
The list of events to enable for this endpoint.
['*']
indicates that all events are enabled, except those that require explicit selection.
livemode: Option<bool>
Has the value true
if the object exists in live mode or the value false
if the object exists in test mode.
metadata: Metadata
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.
secret: Option<String>
The endpoint's secret, used to generate webhook signatures.
Only returned at creation.
status: Option<WebhookEndpointStatus>
The status of the webhook.
It can be enabled
or disabled
.
url: Option<String>
The URL of the webhook endpoint.
Implementations
impl WebhookEndpoint
[src]
pub fn list(
client: &Client,
params: ListWebhookEndpoints<'_>
) -> Response<List<WebhookEndpoint>>
[src]
client: &Client,
params: ListWebhookEndpoints<'_>
) -> Response<List<WebhookEndpoint>>
Returns a list of your webhook endpoints.
pub fn create(
client: &Client,
params: CreateWebhookEndpoint<'_>
) -> Response<WebhookEndpoint>
[src]
client: &Client,
params: CreateWebhookEndpoint<'_>
) -> Response<WebhookEndpoint>
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.
pub fn retrieve(
client: &Client,
id: &WebhookEndpointId,
expand: &[&str]
) -> Response<WebhookEndpoint>
[src]
client: &Client,
id: &WebhookEndpointId,
expand: &[&str]
) -> Response<WebhookEndpoint>
Retrieves the webhook endpoint with the given ID.
pub fn update(
client: &Client,
id: &WebhookEndpointId,
params: UpdateWebhookEndpoint<'_>
) -> Response<WebhookEndpoint>
[src]
client: &Client,
id: &WebhookEndpointId,
params: UpdateWebhookEndpoint<'_>
) -> Response<WebhookEndpoint>
Updates the webhook endpoint.
You may edit the url
, the list of enabled_events
, and the status of your endpoint.
pub fn delete(
client: &Client,
id: &WebhookEndpointId
) -> Response<Deleted<WebhookEndpointId>>
[src]
client: &Client,
id: &WebhookEndpointId
) -> Response<Deleted<WebhookEndpointId>>
You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.
Trait Implementations
impl Clone for WebhookEndpoint
[src]
fn clone(&self) -> WebhookEndpoint
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for WebhookEndpoint
[src]
impl<'de> Deserialize<'de> for WebhookEndpoint
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Object for WebhookEndpoint
[src]
type Id = WebhookEndpointId
The canonical id type for this object.
fn id(&self) -> Self::Id
[src]
fn object(&self) -> &'static str
[src]
impl Serialize for WebhookEndpoint
[src]
Auto Trait Implementations
impl RefUnwindSafe for WebhookEndpoint
[src]
impl Send for WebhookEndpoint
[src]
impl Sync for WebhookEndpoint
[src]
impl Unpin for WebhookEndpoint
[src]
impl UnwindSafe for WebhookEndpoint
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,