List all event destinations v2

Core Resources

Event Destinations

List all event destinations

Lists all event destinations.

Learn more about calling API v2 endpoints.

Parameters

includearray of enums
Additional fields to include in the response. Currently supports webhook_endpoint.url.
Possible enum values
webhook_endpoint.url
Include parameter to expose webhook_endpoint.url.

limitinteger
The page size.

pagestring
The requested page.

Returns

Response attributes

dataarray of objects
List of event destinations.
- data.idstring
  Unique identifier for the object.
- data.objectstring, 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.
- data.amazon_eventbridgenullable object
  Amazon EventBridge configuration.
  data.amazon_eventbridge.aws_account_idstring
  The AWS account ID.
  data.amazon_eventbridge.aws_event_source_arnstring
  The ARN of the AWS event source.
  data.amazon_eventbridge.aws_event_source_statusenum
  The state of the AWS event source.
  Possible enum values
  active
  The event source is in active state.
  deleted
  The event source is in deleted state.
  pending
  The event source is in pending state.
  unknown
  The event source state cannot be retrieved.
- data.createdtimestamp
  Time at which the object was created.
- data.descriptionstring
  An optional description of what the event destination is used for.
- data.enabled_eventsarray of strings
  The list of events to enable for this endpoint.
- data.event_payloadenum
  Payload type of events being subscribed to.
  Possible enum values
  snapshot
  Events from v1 APIs.
  thin
  Events from v2 APIs.
- data.events_fromnullable array of enums
  Where events should be routed from.
  Possible enum values
  other_accounts
  Receive events from accounts connected to the account that owns the event destination.
  self
  Receive events from the account that owns the event destination.
- data.livemodeboolean
  Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- data.metadatanullable map
  Metadata.
- data.namestring
  Event destination name.
- data.snapshot_api_versionnullable string
  If using the snapshot event payload, the API version events are rendered as.
- data.statusenum
  Status. It can be set to either enabled or disabled.
  Possible enum values
  disabled
  Event destination is disabled.
  enabled
  Event destination is enabled.
- data.status_detailsnullable object
  Additional information about event destination status.
  data.status_details.disablednullable object
  Details about why the event destination has been disabled.
  data.status_details.disabled.reasonenum
  Reason event destination has been disabled.
  Possible enum values
  no_aws_event_source_exists
  Event destination has been disabled because the underlying AWS event source does not exist.
  user
  Event destination has been disabled by user.
- data.typeenum
  Event destination type.
  Possible enum values
  amazon_eventbridge
  Amazon EventBridge.
  webhook_endpoint
  Webhook endpoint.
- data.updatedtimestamp
  Time at which the object was last updated.
- data.webhook_endpointnullable object
  Webhook endpoint configuration.
  data.webhook_endpoint.signing_secretnullable string
  The signing secret of the webhook endpoint, only includable on creation.
  data.webhook_endpoint.urlnullable string
  The URL of the webhook endpoint, includable.

next_page_urlnullable string
The next page url.

previous_page_urlnullable string
The previous page url.

GET /v2/core/event_destinations

Server-side language

curl -G https://api.stripe.com/v2/core/event_destinations \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-08-27.preview" \
  -d include="webhook_endpoint.url"

Response

{
  "data": [
    {
      "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": "disabled",
      "status_details": {
        "disabled": {
          "reason": "user"
        }
      },
      "type": "webhook_endpoint",
      "updated": "2024-10-22T16:22:02.524Z",
      "webhook_endpoint": {
        "signing_secret": null,
        "url": null
      }
    }
  ],
  "next_page_url": null,
  "previous_page_url": null
}

List all event destinations v2

Parameters

includearray of enums

limitinteger

pagestring

Returns

Response attributes

dataarray of objects

data.idstring

data.objectstring, value is "v2.core.event_destination"

data.amazon_eventbridgenullable object

data.amazon_eventbridge.aws_account_idstring

data.amazon_eventbridge.aws_event_source_arnstring

data.amazon_eventbridge.aws_event_source_statusenum

data.createdtimestamp

data.descriptionstring

data.enabled_eventsarray of strings

data.event_payloadenum

data.events_fromnullable array of enums

data.livemodeboolean

data.metadatanullable map

data.namestring

data.snapshot_api_versionnullable string

data.statusenum

data.status_detailsnullable object

data.status_details.disablednullable object

data.status_details.disabled.reasonenum

data.typeenum

data.updatedtimestamp

data.webhook_endpointnullable object

data.webhook_endpoint.signing_secretnullable string

data.webhook_endpoint.urlnullable string

next_page_urlnullable string

previous_page_urlnullable string