Retrieve an Event Destination

Retrieves the details of an event destination.

Parameters

• include (array of enums, optional) Additional fields to include in the response. Possible enum values:
  • webhook_endpoint.url Include parameter to expose webhook_endpoint.url.

Returns

Response 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 (object, nullable) Amazon EventBridge configuration.

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

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

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

• azure_event_grid (object, nullable) Azure Event Grid configuration.

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

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

  • azure_event_grid.azure_region (string) The Azure region.

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

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

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

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

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

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

  • snapshot Events from v1 APIs.

  • thin Events from v2 APIs.

• 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) Metadata.

• name (string) Event destination name.

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

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

• status_details (object, nullable) Additional information about event destination status.

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

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

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

  • amazon_eventbridge Amazon EventBridge.

  • azure_event_grid Azure Event Grid.

  • webhook_endpoint Webhook endpoint.

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

• webhook_endpoint (object, nullable) Webhook endpoint configuration.

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

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

Error Codes

HTTP status code	Code	Description
404	not_found	The resource wasn’t found.

curl -G https://api.stripe.com/v2/core/event_destinations/ed_test_61RM8ltWcTW4mbsxf16RJyfa2xSQLHJJh1sxm7H0KVT6 \
  -H "Authorization: Bearer <<YOUR_SECRET_KEY>>" \
  -H "Stripe-Version: 2026-04-22.dahlia" \
  -d "include[0]=webhook_endpoint.url"

Response

{
  "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
  }
}