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}

Delete an Event Destination v2

DELETE / v2 / core / event_destinations /:id

Delete an event destination.

Learn more about calling API v2 endpoints.

Parameters

No parameters.

Returns

Response attributes

id string The ID of the object that’s being deleted.
object nullable string String representing the type of the object that has been deleted. Objects of the same type share the same value of the object field.

Error Codes

404 not _ found

The resource wasn’t found.

409 idempotency _ error

An idempotent retry occurred with different request parameters.

Response

{ "id": "ed_test_61RM8ltWcTW4mbsxf16RJyfa2xSQLHJJh1sxm7H0KVT6", "object": "v2.core.event_destination", "deleted": true}

Disable an Event Destination v2

POST / v2 / core / event_destinations /:id / disable

Disable an event destination.

Learn more about calling API v2 endpoints.

Parameters

No parameters.

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

{ "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:21:38.634Z", "webhook_endpoint": { "signing_secret": null, "url": null }}