Struct WebhookEndpoint

pub struct WebhookEndpoint {
    pub api_version: Option<String>,
    pub application: Option<String>,
    pub created: i64,
    pub description: Option<String>,
    pub enabled_events: Vec<String>,
    pub id: String,
    pub livemode: bool,
    pub metadata: Value,
    pub object: String,
    pub secret: Option<String>,
    pub status: String,
    pub url: String,
}

You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.

Most users configure webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints.

Related guide: Setting up webhooks

Fields

api_version: Option<String>

The API version events are rendered as for this webhook endpoint.

application: Option<String>

The ID of the associated Connect application.

created: i64

Time at which the object was created. Measured in seconds since the Unix epoch.

description: Option<String>

An optional description of what the webhook is used for.

enabled_events: Vec<String>

The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.

id: String

Unique identifier for the object.

livemode: bool

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata: Value

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.

object: String

String representing the object’s type. Objects of the same type share the same value.

secret: Option<String>

The endpoint’s secret, used to generate webhook signatures. Only returned at creation.

status: String

The status of the webhook. It can be enabled or disabled.

url: String

The URL of the webhook endpoint.

Trait Implementations

impl Clone for WebhookEndpoint

fn clone(&self) -> WebhookEndpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebhookEndpoint

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

Formats the value using the given formatter.

impl Default for WebhookEndpoint

fn default() -> WebhookEndpoint

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebhookEndpoint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for WebhookEndpoint

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

Formats the value using the given formatter.

impl Serialize for WebhookEndpoint

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

where __S: Serializer,

Serialize this value into the given Serde serializer.