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 }}
Enable an Event Destination v2
POST / v2 / core / event_destinations /:id / enable
Enable 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": "enabled", "status_details": null, "type": "webhook_endpoint", "updated": "2024-10-22T16:21:38.634Z", "webhook_endpoint": { "signing_secret": null, "url": null }}