NAME
Net::API::Stripe::WebHook::Object - An Stripe WebHook Object
SYNOPSIS
my $hook = $stripe->webhook({
api_version => '2020-03-02',
application => undef,
enabled_events => ['*'],
livemode => $stripe->false,
status => 'enabled',
url => 'https://api.example.con/stripe/CAC29A87-991E-44AF-8636-888E03082DDF',
});See documentation in Net::API::Stripe for example to make api calls to Stripe to create those objects.
VERSION
v0.1.0DESCRIPTION
This is a Stripe webhook endpoint object.
CONSTRUCTOR
new( %ARG )
Creates a new Net::API::Stripe::WebHook::Object object. It may also take an hash like arguments, that also are method of the same name.
METHODS
id string
Unique identifier for the object.
object string, value is "webhook_endpoint"
String representing the object’s type. Objects of the same type share the same value.
api_version string
The API version events are rendered as for this webhook endpoint.
application string
The ID of the associated Connect application.
created timestamp
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 array containing strings
The list of events to enable for this endpoint. You may specify ['*'] to enable all events.
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 hash
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 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.
API SAMPLE
{
"id": "we_fake123456789",
"object": "webhook_endpoint",
"api_version": "2017-02-14",
"application": null,
"created": 1542006805,
"enabled_events": [
"invoice.created",
"invoice.payment_failed",
"invoice.payment_succeeded"
],
"livemode": false,
"status": "enabled",
"url": "http://expugno.serveo.net/stripe/invoice"
}HISTORY
v0.1
Initial version
AUTHOR
Jacques Deguest <jack@deguest.jp>
SEE ALSO
Stripe API documentation:
https://stripe.com/docs/api/webhook_endpoints
COPYRIGHT & LICENSE
Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.