[−][src]Struct stripe::WebhookEndpoint
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
enabled_events: Option<Vec<EventFilter>>
The list of events to enable for this endpoint.
You may specify ['*']
to enable all events.
livemode: bool
Has the value true
if the object exists in live mode or the value false
if the object exists in test mode.
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.
Methods
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 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 Clone for WebhookEndpoint
[src]
fn clone(&self) -> WebhookEndpoint
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for WebhookEndpoint
[src]
impl Serialize for WebhookEndpoint
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl<'de> Deserialize<'de> for WebhookEndpoint
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
Auto Trait Implementations
impl Unpin for WebhookEndpoint
impl Sync for WebhookEndpoint
impl Send for WebhookEndpoint
impl UnwindSafe for WebhookEndpoint
impl RefUnwindSafe for WebhookEndpoint
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for 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.
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.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> Erased for T
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
U: TryFrom<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self