Create an Event Destination v2

POST / v2 / core / event_destinations

Create a new event destination.

Learn more about calling API v2 endpoints.

Parameters

• enabled _ events array of strings Required The list of events to enable for this endpoint.
• event _ payload enum Required Payload type of events being subscribed to. Possible enum values snapshot Events from v1 APIs. thin Events from v2 APIs.
• name string Required Event destination name.
• type enum Required Event destination type. Possible enum values amazon_eventbridge Amazon EventBridge. azure_event_grid Azure Event Grid. webhook_endpoint Webhook endpoint.
• amazon _ eventbridge object Amazon EventBridge configuration.
• azure _ event _ grid object Azure Event Grid configuration.
• description string An optional description of what the event destination is used for.
• events _ from array of strings Specifies which accounts’ events route to this destination. @self: Receive events from the account that owns the event destination. @accounts: Receive events emitted from other accounts you manage which includes your v1 and v2 accounts. @organization_members: Receive events from accounts directly linked to the organization. @organization_members/@accounts: Receive events from all accounts connected to any platform accounts in the organization.
• include array of enums Additional fields to include in the response. Possible enum values webhook_endpoint.signing_secret Include parameter to expose webhook_endpoint.signing_secret. webhook_endpoint.url Include parameter to expose webhook_endpoint.url.
• metadata map Metadata.
• snapshot _ api _ version string If using the snapshot event payload, the API version events are rendered as.
• webhook _ endpoint object Webhook endpoint configuration.

Returns

Returns an Event Destination object.

Error Codes

400 expired _ azure _ partner _ authorization

Error returned when a user tries to create an event destination with an expired Azure partner authorization.

400 invalid _ azure _ partner _ authorization

Error returned when a user tries to create an event destination without an Azure partner authorization.

400 invalid _ azure _ partner _ configuration

Error returned when no valid partner configuration is found using the user provided Azure subscription ID and Azure resource group name.

409 idempotency _ error

An idempotent retry occurred with different request parameters.

Response

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 }}