Package com.stripe.model.v2.core

Class EventDestination

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.core.EventDestination
All Implemented Interfaces:
HasId, StripeObjectInterface
public class EventDestination extends StripeObject implements HasId
Set up an event destination to receive events from Stripe across multiple destination types, including webhook endpoints, Amazon EventBridge, and Azure Event Grid. Event destinations support receiving thin events and snapshot events.

  • Constructor Details

    • EventDestination

      public EventDestination()

  • Method Details

    • getAmazonEventbridge

      public EventDestination.AmazonEventbridge getAmazonEventbridge()
      Configuration for delivering events through an Amazon EventBridge partner event source.

    • getAzureEventGrid

      public EventDestination.AzureEventGrid getAzureEventGrid()
      Configuration for delivering events through an Azure Event Grid partner topic.

    • getCreated

      public Instant getCreated()
      The time when the destination was created.

    • getDescription

      public String getDescription()
      An optional user-defined description of the destination's purpose.

    • getEnabledEvents

      public List<String> getEnabledEvents()
      The list of event types enabled for delivery to this destination.

    • getEventPayload

      public String getEventPayload()
      Whether to deliver as snapshot or thin events.

      One of snapshot, or thin.

    • getEventsFrom

      public List<String> getEventsFrom()
      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.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getMetadata

      public Map<String,String> getMetadata()
      User-defined key/value data for the destination; it has no effect on event matching or delivery.

    • getName

      public String getName()
      A user-defined label for identifying the destination in Stripe.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value of the object field.

      Equal to v2.core.event_destination.

    • getSnapshotApiVersion

      public String getSnapshotApiVersion()
      For snapshot events only, the Stripe API version used to render event objects. Thin events are not pinned to an API version.

    • getStatus

      public String getStatus()
      Whether Stripe currently attempts delivery. Stripe attempts delivery to enabled destinations when their provider configuration is active; disabled destinations do not receive delivery attempts.

      One of disabled, or enabled.

    • getStatusDetails

      public EventDestination.StatusDetails getStatusDetails()
      Additional lifecycle context for the destination status, when available.

    • getType

      public String getType()
      The delivery transport. Chosen when the destination is created and cannot be changed by update.

      One of amazon_eventbridge, azure_event_grid, or webhook_endpoint.

    • getUpdated

      public Instant getUpdated()
      The time when the destination object was last updated.

    • getWebhookEndpoint

      public EventDestination.WebhookEndpoint getWebhookEndpoint()
      Configuration for delivering events to a webhook endpoint. Live mode requires HTTPS; sandbox mode also supports HTTP.

    • setAmazonEventbridge

      public void setAmazonEventbridge(EventDestination.AmazonEventbridge amazonEventbridge)
      Configuration for delivering events through an Amazon EventBridge partner event source.

    • setAzureEventGrid

      public void setAzureEventGrid(EventDestination.AzureEventGrid azureEventGrid)
      Configuration for delivering events through an Azure Event Grid partner topic.

    • setCreated

      public void setCreated(Instant created)
      The time when the destination was created.

    • setDescription

      public void setDescription(String description)
      An optional user-defined description of the destination's purpose.

    • setEnabledEvents

      public void setEnabledEvents(List<String> enabledEvents)
      The list of event types enabled for delivery to this destination.

    • setEventPayload

      public void setEventPayload(String eventPayload)
      Whether to deliver as snapshot or thin events.

      One of snapshot, or thin.

    • setEventsFrom

      public void setEventsFrom(List<String> eventsFrom)
      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.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setMetadata

      public void setMetadata(Map<String,String> metadata)
      User-defined key/value data for the destination; it has no effect on event matching or delivery.

    • setName

      public void setName(String name)
      A user-defined label for identifying the destination in Stripe.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value of the object field.

      Equal to v2.core.event_destination.

    • setSnapshotApiVersion

      public void setSnapshotApiVersion(String snapshotApiVersion)
      For snapshot events only, the Stripe API version used to render event objects. Thin events are not pinned to an API version.

    • setStatus

      public void setStatus(String status)
      Whether Stripe currently attempts delivery. Stripe attempts delivery to enabled destinations when their provider configuration is active; disabled destinations do not receive delivery attempts.

      One of disabled, or enabled.

    • setStatusDetails

      public void setStatusDetails(EventDestination.StatusDetails statusDetails)
      Additional lifecycle context for the destination status, when available.

    • setType

      public void setType(String type)
      The delivery transport. Chosen when the destination is created and cannot be changed by update.

      One of amazon_eventbridge, azure_event_grid, or webhook_endpoint.

    • setUpdated

      public void setUpdated(Instant updated)
      The time when the destination object was last updated.

    • setWebhookEndpoint

      public void setWebhookEndpoint(EventDestination.WebhookEndpoint webhookEndpoint)
      Configuration for delivering events to a webhook endpoint. Live mode requires HTTPS; sandbox mode also supports HTTP.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId