| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe; |
| 6 |
|
| 7 |
/** |
| 8 |
* You can configure <a href="https://stripe.com/docs/webhooks/">webhook |
| 9 |
* endpoints</a> via the API to be notified about events that happen in your Stripe |
| 10 |
* account or connected accounts. |
| 11 |
* |
| 12 |
* Most users configure webhooks from <a |
| 13 |
* href="https://dashboard.stripe.com/webhooks">the dashboard</a>, which provides a |
| 14 |
* user interface for registering and testing your webhook endpoints. |
| 15 |
* |
| 16 |
* Related guide: <a href="https://stripe.com/docs/webhooks/configure">Setting up |
| 17 |
* Webhooks</a>. |
| 18 |
* |
| 19 |
* @property string $id Unique identifier for the object. |
| 20 |
* @property string $object String representing the object's type. Objects of the same type share the same value. |
| 21 |
* @property null|string $api_version The API version events are rendered as for this webhook endpoint. |
| 22 |
* @property null|string $application The ID of the associated Connect application. |
| 23 |
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 24 |
* @property null|string $description An optional description of what the webhook is used for. |
| 25 |
* @property string[] $enabled_events The list of events to enable for this endpoint. <code>['*']</code> indicates that all events are enabled, except those that require explicit selection. |
| 26 |
* @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode. |
| 27 |
* @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
| 28 |
* @property string $secret The endpoint's secret, used to generate <a href="https://stripe.com/docs/webhooks/signatures">webhook signatures</a>. Only returned at creation. |
| 29 |
* @property string $status The status of the webhook. It can be <code>enabled</code> or <code>disabled</code>. |
| 30 |
* @property string $url The URL of the webhook endpoint. |
| 31 |
*/ |
| 32 |
class WebhookEndpoint extends ApiResource |
| 33 |
{ |
| 34 |
const OBJECT_NAME = 'webhook_endpoint'; |
| 35 |
|
| 36 |
use ApiOperations\All; |
| 37 |
use ApiOperations\Create; |
| 38 |
use ApiOperations\Delete; |
| 39 |
use ApiOperations\Retrieve; |
| 40 |
use ApiOperations\Update; |
| 41 |
} |
| 42 |
|
