Struct stripe::WebhookEndpoint
source · pub struct WebhookEndpoint {
pub id: WebhookEndpointId,
pub api_version: Option<ApiVersion>,
pub application: Option<String>,
pub created: Option<Timestamp>,
pub deleted: bool,
pub description: Option<String>,
pub enabled_events: Option<Vec<EventFilter>>,
pub livemode: Option<bool>,
pub metadata: Option<Metadata>,
pub secret: Option<String>,
pub status: Option<WebhookEndpointStatus>,
pub url: Option<String>,
}
Expand description
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: Option<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§
source§impl WebhookEndpoint
impl WebhookEndpoint
sourcepub fn list(
client: &Client,
params: &ListWebhookEndpoints<'_>
) -> Response<List<WebhookEndpoint>>
pub fn list( client: &Client, params: &ListWebhookEndpoints<'_> ) -> Response<List<WebhookEndpoint>>
Returns a list of your webhook endpoints.
sourcepub fn create(
client: &Client,
params: CreateWebhookEndpoint<'_>
) -> Response<WebhookEndpoint>
pub fn create( 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.
sourcepub fn retrieve(
client: &Client,
id: &WebhookEndpointId,
expand: &[&str]
) -> Response<WebhookEndpoint>
pub fn retrieve( client: &Client, id: &WebhookEndpointId, expand: &[&str] ) -> Response<WebhookEndpoint>
Retrieves the webhook endpoint with the given ID.
sourcepub fn update(
client: &Client,
id: &WebhookEndpointId,
params: UpdateWebhookEndpoint<'_>
) -> Response<WebhookEndpoint>
pub fn update( 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.
sourcepub fn delete(
client: &Client,
id: &WebhookEndpointId
) -> Response<Deleted<WebhookEndpointId>>
pub fn delete( 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§
source§impl Clone for WebhookEndpoint
impl Clone for WebhookEndpoint
source§fn clone(&self) -> WebhookEndpoint
fn clone(&self) -> WebhookEndpoint
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more