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

• 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.
• include array 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.
• metadata map Metadata.
• name string Event destination name.
• webhook _ endpoint object Webhook endpoint configuration.

Returns

Returns an Event Destination object.

Error Codes

404 not _ found

The resource wasn’t found.

409 idempotency _ error

An idempotent retry occurred with different request parameters.

Response

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

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

Returns

Returns an Event Destination object.

Error Codes

404 not _ found

The resource wasn’t found.

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

• include array 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.
• limit integer The page size.
• page string The requested page.

Returns

Response attributes

• data array of objects List of event destinations.
• next _ page _ url nullable string URL to fetch the next page of the list. If there are no more pages, the value is null.
• previous _ page _ url nullable string URL to fetch the previous page of the list. If there are no previous pages, the value is null.

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}