View Source ExOAPI.Stripe.Schemas.WebhookEndpoint (exoapi_stripe v0.1.4)
description: 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.
:api_version :: :string
The API version events are rendered as for this webhook endpoint.
:application :: ExOAPI.Stripe.Schemas.Application
The ID of the associated Connect application.
:created :: :integer
Time at which the object was created. Measured in seconds since the Unix epoch.
:description :: :string
An optional description of what the webhook is used for.
::enabled_events :: :string
:id :: :string
Unique identifier for the object.
:livemode :: :boolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
:metadata :: :map
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 :: :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.
Link to this section Summary
Link to this section Types
@type params() :: map()
@type t() :: %ExOAPI.Stripe.Schemas.WebhookEndpoint{ api_version: String.t() | nil, application: String.t() | nil, created: integer() | nil, description: String.t() | nil, enabled_events: [String.t()] | nil, id: String.t() | nil, livemode: boolean() | nil, metadata: map() | nil, object: :webhook_endpoint | nil, secret: String.t() | nil, status: String.t() | nil, url: String.t() | nil }
Link to this section Functions
@spec changeset(t(), params()) :: Ecto.Changeset.t()