Core Resources
Payment Methods
Products
Product Catalog
Commerce
Agentic Commerce
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury for Platforms
Payment Records
Account Evaluation
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Update an Event Destination v2

POST /v2/core/event_destinations/:id

Update the details of an event destination.

Learn more about calling API v2 endpoints

Parameters

  • descriptionstring

    An optional user-defined description of the destination’s purpose; it does not control routing.

  • enabled_eventsarray of strings

    The list of event types enabled for delivery to this destination. Event scopes are configured when the destination is created.

  • includearray of enums

    Include the normally redacted webhook_endpoint.url in the response.

    Possible enum values
    webhook_endpoint.url

    Include the normally redacted webhook_endpoint.url in the response.

  • metadatamap

    Metadata.

  • namestring

    A user-defined label for identifying the destination; it does not control routing.

  • webhook_endpointobject

    New delivery target for the webhook endpoint. Live mode requires HTTPS; sandbox mode also supports HTTP.

Returns

Returns an Event Destination object.

Error Codes
404not_found

The resource wasn’t found.

409idempotency_error

An idempotent retry occurred with different request parameters.

curl -X POST https://api.stripe.com/v2/core/event_destinations/ed_test_61RM8ltWcTW4mbsxf16RJyfa2xSQLHJJh1sxm7H0KVT6 \
  -H "Authorization: Bearer sk_test_BQokikJOvBiI2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2026-09-30.endive" \
  --json '{
    "description": "A better description",
    "enabled_events": [
        "v1.billing.meter.error_report_triggered",
        "v1.billing.meter.no_meter_found"
    ],
    "include": [
        "webhook_endpoint.url"
    ]
  }'
Response
{
  "id": "ed_test_61RM8ltWcTW4mbsxf16RJyfa2xSQLHJJh1sxm7H0KVT6",
  "object": "v2.core.event_destination",
  "created": "2024-10-22T16:20:09.931Z",
  "description": "A better description",
  "enabled_events": [
    "v1.billing.meter.error_report_triggered",
    "v1.billing.meter.no_meter_found"
  ],
  "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:25:48.976Z",
  "webhook_endpoint": {
    "signing_secret": null,
    "url": "https://example.com/my/webhook/endpoint"
  }
}

Retrieve an Event Destination v2

GET /v2/core/event_destinations/:id

Retrieves the details of an event destination.

Learn more about calling API v2 endpoints

Parameters

  • includearray of enums

    Additional fields to include in the response.

    Possible enum values
    webhook_endpoint.url

    Include the normally redacted webhook_endpoint.url in the response.

Returns

Returns an Event Destination object.

Error Codes
404not_found

The resource wasn’t found.

curl -G https://api.stripe.com/v2/core/event_destinations/ed_test_61RM8ltWcTW4mbsxf16RJyfa2xSQLHJJh1sxm7H0KVT6 \
  -H "Authorization: Bearer sk_test_BQokikJOvBiI2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2026-09-30.endive" \
  -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
  }
}

List Event Destinations v2

GET /v2/core/event_destinations

Lists all event destinations.

Learn more about calling API v2 endpoints

Parameters

  • includearray of enums

    Include the normally redacted webhook_endpoint.url in each returned destination.

    Possible enum values
    webhook_endpoint.url

    Include the normally redacted webhook_endpoint.url in the response.

  • limitinteger

    The page size.

  • pagestring

    The requested page.

Returns

Response attributes

  • dataarray of objects

    List of event destinations.

  • next_page_urlnullable string

    URL to fetch the next page of the list. If there are no more pages, the value is null.

  • previous_page_urlnullable string

    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 sk_test_BQokikJOvBiI2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2026-09-30.endive" \
  -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
}