List Event Destinations

Lists all event destinations.

Parameters

• include (array of enums, optional) 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.

• limit (integer, optional) The page size.

• page (string, optional) The requested page.

Returns

Response attributes

• data (array of objects) List of event destinations.

  • data.id (string) Unique identifier for the object.

  • data.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.

  • data.amazon_eventbridge (object, nullable) Amazon EventBridge configuration.

    • data.amazon_eventbridge.aws_account_id (string) The AWS account ID.

    • data.amazon_eventbridge.aws_event_source_arn (string) The ARN of the AWS event source.

    • data.amazon_eventbridge.aws_event_source_status (enum) 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.azure_event_grid (object, nullable) Azure Event Grid configuration.

    • data.azure_event_grid.azure_partner_topic_name (string) The name of the Azure partner topic.

    • data.azure_event_grid.azure_partner_topic_status (enum) The status of the Azure partner topic. Possible enum values:

      • activated The partner topic is activated.

      • deleted The partner topic is deleted.

      • never_activated The partner topic has never been activated before.

      • unknown The partner topic status is unknown.

    • data.azure_event_grid.azure_region (string) The Azure region.

    • data.azure_event_grid.azure_resource_group_name (string) The name of the Azure resource group.

    • data.azure_event_grid.azure_subscription_id (string) The Azure subscription ID.

  • data.created (timestamp) Time at which the object was created.

  • data.description (string) An optional description of what the event destination is used for.

  • data.enabled_events (array of strings) The list of events to enable for this endpoint.

  • data.event_payload (enum) Payload type of events being subscribed to. Possible enum values:

    • snapshot Events from v1 APIs.

    • thin Events from v2 APIs.

  • data.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.

  • data.livemode (boolean) Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • data.metadata (map, nullable) Metadata.

  • data.name (string) Event destination name.

  • data.snapshot_api_version (string, nullable) If using the snapshot event payload, the API version events are rendered as.

  • data.status (enum) 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_details (object, nullable) Additional information about event destination status.

    • data.status_details.disabled (object, nullable) Details about why the event destination has been disabled.

      • data.status_details.disabled.reason (enum) 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.

        • no_azure_partner_topic_exists Event destination has been disabled because the underlying Azure partner topic does not exist.

        • user Event destination has been disabled by user.

  • data.type (enum) Event destination type. Possible enum values:

    • amazon_eventbridge Amazon EventBridge.

    • azure_event_grid Azure Event Grid.

    • webhook_endpoint Webhook endpoint.

  • data.updated (timestamp) Time at which the object was last updated.

  • data.webhook_endpoint (object, nullable) Webhook endpoint configuration.

    • data.webhook_endpoint.signing_secret (string, nullable) The signing secret of the webhook endpoint, only includable on creation.

    • data.webhook_endpoint.url (string, nullable) The URL of the webhook endpoint, includable.

• next_page_url (string, nullable) URL to fetch the next page of the list. If there are no more pages, the value is null.

• previous_page_url (string, nullable) URL to fetch the previous page of the list. If there are no previous pages, the value is null.

curl -G https://api.stripe.com/v2/core/event_destinations \
  -H "Authorization: Bearer <<YOUR_SECRET_KEY>>" \
  -H "Stripe-Version: 2026-04-22.dahlia" \
  -d "include[0]=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
}