Lists all event destinations.
Parameters
- includearray of enums
Additional fields to include in the response. Currently supports
webhook_
.endpoint. url Possible enum valueswebhook_
endpoint. url Include parameter to expose
webhook_
.endpoint. url - limitinteger
The page size.
- pagestring
The requested page.
Returns
Response attributes
- dataarray of objects
List of event destinations.
- next_
page_ urlnullable string The next page url.
- previous_
page_ urlnullable string The previous page url.
{ "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.
Parameters
- idstringRequired
Identifier for the event destination to delete.
Returns
Response attributes
- idstring
Identifier for the deleted event destination.
The resource wasn’t found.
An idempotent retry occurred with different request parameters.
{ "id": "ed_test_61RM8ltWcTW4mbsxf16RJyfa2xSQLHJJh1sxm7H0KVT6"}
Disable an event destination.
Parameters
- idstringRequired
Identifier for the event destination to disable.
Returns
Response attributes
- idstring
Unique identifier for the object.
- objectstring, 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_
eventbridgenullable object Amazon EventBridge configuration.
- createdtimestamp
Time at which the object was created.
- descriptionstring
An optional description of what the event destination is used for.
- enabled_
eventsarray of strings The list of events to enable for this endpoint.
- event_
payloadenum Payload type of events being subscribed to.
Possible enum valuessnapshot
Events from v1 APIs.
thin
Events from v2 APIs.
- events_
fromnullable array of enums Where events should be routed from.
Possible enum valuesother_
accounts Receive events from accounts connected to the account that owns the event destination.
self
Receive events from the account that owns the event destination.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - metadatanullable map
Metadata.
- namestring
Event destination name.
- snapshot_
api_ versionnullable string If using the snapshot event payload, the API version events are rendered as.
- statusenum
Status. It can be set to either enabled or disabled.
Possible enum valuesdisabled
Event destination is disabled.
enabled
Event destination is enabled.
- status_
detailsnullable object Additional information about event destination status.
- typeenum
Event destination type.
Possible enum valuesamazon_
eventbridge Amazon EventBridge.
webhook_
endpoint Webhook endpoint.
- updatedtimestamp
Time at which the object was last updated.
- webhook_
endpointnullable object Webhook endpoint configuration.
The resource wasn’t found.
An idempotent retry occurred with different request parameters.
{ "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.
Parameters
- idstringRequired
Identifier for the event destination to enable.
Returns
Response attributes
- idstring
Unique identifier for the object.
- objectstring, 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_
eventbridgenullable object Amazon EventBridge configuration.
- createdtimestamp
Time at which the object was created.
- descriptionstring
An optional description of what the event destination is used for.
- enabled_
eventsarray of strings The list of events to enable for this endpoint.
- event_
payloadenum Payload type of events being subscribed to.
Possible enum valuessnapshot
Events from v1 APIs.
thin
Events from v2 APIs.
- events_
fromnullable array of enums Where events should be routed from.
Possible enum valuesother_
accounts Receive events from accounts connected to the account that owns the event destination.
self
Receive events from the account that owns the event destination.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - metadatanullable map
Metadata.
- namestring
Event destination name.
- snapshot_
api_ versionnullable string If using the snapshot event payload, the API version events are rendered as.
- statusenum
Status. It can be set to either enabled or disabled.
Possible enum valuesdisabled
Event destination is disabled.
enabled
Event destination is enabled.
- status_
detailsnullable object Additional information about event destination status.
- typeenum
Event destination type.
Possible enum valuesamazon_
eventbridge Amazon EventBridge.
webhook_
endpoint Webhook endpoint.
- updatedtimestamp
Time at which the object was last updated.
- webhook_
endpointnullable object Webhook endpoint configuration.
The resource wasn’t found.
An idempotent retry occurred with different request parameters.
{ "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 }}
This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.
Event types
Attributes
- idstring
Unique identifier for the event.
- objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.
- contextnullable string
Authentication context needed to fetch the event or related object.
- createdtimestamp
Time at which the object was created.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - reasonnullable object
Reason for the event.
- related_
objectnullable object Object containing the reference to API resource relevant to the event.
- typestring, value is "v2.core.event_destination.ping"
The type of the event.
Fetched attributes
- dataobject
Additional data about the event.
{ "context": null, "created": "2025-01-01T00:00:00.000Z", "id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u", "object": "v2.core.event", "reason": { "type": "request", "request": { "id": "req_v24sUK2aV6o01RdVU", "idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2" } }, "related_object": { "id": "ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me", "type": "v2.core.event_destination", "url": "/v2/core/event_destinations/ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me" }, "type": "v2.core.event_destination.ping", "livemode": true}
{ "context": null, "created": "2025-01-01T00:00:00.000Z", "id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u", "object": "v2.core.event", "reason": { "type": "request", "request": { "id": "req_v24sUK2aV6o01RdVU", "idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2" } }, "related_object": { "id": "ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me", "type": "v2.core.event_destination", "url": "/v2/core/event_destinations/ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me" }, "type": "v2.core.event_destination.ping", "livemode": true, "changes": {}, "data": {}}