WebhookEndpoint.php 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe;
  4. /**
  5. * You can configure <a href="https://stripe.com/docs/webhooks/">webhook
  6. * endpoints</a> via the API to be notified about events that happen in your Stripe
  7. * account or connected accounts.
  8. *
  9. * Most users configure webhooks from <a
  10. * href="https://dashboard.stripe.com/webhooks">the dashboard</a>, which provides a
  11. * user interface for registering and testing your webhook endpoints.
  12. *
  13. * Related guide: <a href="https://stripe.com/docs/webhooks/configure">Setting up
  14. * Webhooks</a>.
  15. *
  16. * @property string $id Unique identifier for the object.
  17. * @property string $object String representing the object's type. Objects of the same type share the same value.
  18. * @property null|string $api_version The API version events are rendered as for this webhook endpoint.
  19. * @property null|string $application The ID of the associated Connect application.
  20. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
  21. * @property null|string $description An optional description of what the webhook is used for.
  22. * @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.
  23. * @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.
  24. * @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.
  25. * @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.
  26. * @property string $status The status of the webhook. It can be <code>enabled</code> or <code>disabled</code>.
  27. * @property string $url The URL of the webhook endpoint.
  28. */
  29. class WebhookEndpoint extends ApiResource
  30. {
  31. const OBJECT_NAME = 'webhook_endpoint';
  32. use ApiOperations\All;
  33. use ApiOperations\Create;
  34. use ApiOperations\Delete;
  35. use ApiOperations\Retrieve;
  36. use ApiOperations\Update;
  37. }