# The Event Destination object

### The Event Destination object

```json
{
  "id": "ed_test_61RM8ltWcTW4mbsxf16RJyfa2xSQLHJJh1sxm7H0KVT6",
  "object": "v2.core.event_destination",
  "created": "2024-10-22T16:20:09.931Z",
  "description": "This is my event destination, I like it a lot",
  "enabled_events": [
    "v1.billing.meter.error_report_triggered"
  ],
  "event_payload": "thin",
  "events_from": [
    "@self"
  ],
  "livemode": false,
  "metadata": {},
  "name": "My Event Destination",
  "snapshot_api_version": null,
  "status": "enabled",
  "status_details": null,
  "type": "webhook_endpoint",
  "updated": "2024-10-22T16:20:09.937Z",
  "webhook_endpoint": {
    "signing_secret": null,
    "url": "https://example.com/my/webhook/endpoint"
  }
}
```

## Attributes

- `id` (string)
  Unique identifier for the object.

- `object` (string, value is "v2.core.event_destination")
  String representing the object’s type. Objects of the same type share the same value of the object field.

- [`amazon_eventbridge`](https://docs.stripe.com/api/v2/core/event-destinations/object.md?query=amazon_eventbridge) (object, nullable)
  Configuration for delivering events through an Amazon EventBridge partner event source.

- [`azure_event_grid`](https://docs.stripe.com/api/v2/core/event-destinations/object.md?query=azure_event_grid) (object, nullable)
  Configuration for delivering events through an Azure Event Grid partner topic.

- `created` (timestamp)
  The time when the destination was created.

- `description` (string)
  An optional user-defined description of the destination’s purpose.

- `enabled_events` (array of strings)
  The list of event types enabled for delivery to this destination.

- `event_payload` (enum)
  Whether to deliver as snapshot or thin events.
Possible enum values:
  - `snapshot`
    Events that contain full resource objects in the delivered payload, rendered using a specified API version.

  - `thin`
    A lightweight event notification with an unversioned payload. It identifies the related Stripe resource so you can retrieve the complete event or the resource’s current state. This reduces coupling to API-versioned object snapshots and makes event handlers easier to maintain.

- `events_from` (array of strings, nullable)
  Specifies which accounts’ events route to this destination. `@self`: Receive events from the account that owns the event destination. `@accounts`: Receive events emitted from other accounts you manage which includes your v1 and v2 accounts. `@organization_members`: Receive events from accounts directly linked to the organization. `@organization_members/@accounts`: Receive events from all accounts connected to any platform accounts in the organization.

- `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, nullable)
  User-defined key/value data for the destination; it has no effect on event matching or delivery.

- `name` (string)
  A user-defined label for identifying the destination in Stripe.

- `snapshot_api_version` (string, nullable)
  For snapshot events only, the Stripe API version used to render event objects. You can’t change this value after you create the event destination. Thin events are not pinned to an API version.

- `status` (enum)
  Whether Stripe currently attempts delivery. Stripe attempts delivery to enabled destinations when their provider configuration is active; disabled destinations do not receive delivery attempts.
Possible enum values:
  - `disabled`
    Event destination is disabled.

  - `enabled`
    Event destination is enabled.

- [`status_details`](https://docs.stripe.com/api/v2/core/event-destinations/object.md?query=status_details) (object, nullable)
  Additional lifecycle context for the destination status, when available.

- `type` (enum)
  The delivery transport. Chosen when the destination is created and cannot be changed by update.
Possible enum values:
  - `amazon_eventbridge`
    Deliver matching events through a Stripe partner event source in Amazon EventBridge.

  - `azure_event_grid`
    Deliver matching events through a Stripe partner topic in Azure Event Grid.

  - `webhook_endpoint`
    Deliver matching events to a webhook endpoint. Live mode requires HTTPS; sandbox mode also supports HTTP.

- `updated` (timestamp)
  The time when the destination object was last updated.

- [`webhook_endpoint`](https://docs.stripe.com/api/v2/core/event-destinations/object.md?query=webhook_endpoint) (object, nullable)
  Configuration for delivering events to a webhook endpoint. Live mode requires HTTPS; sandbox mode also supports HTTP.