Package com.stripe.model

Class WebhookEndpoint

    • Constructor Detail

      • WebhookEndpoint

        public WebhookEndpoint()

    • Method Detail

      • create

        public static WebhookEndpoint create​(java.util.Map<java.lang.String,​java.lang.Object> params)
                              throws StripeException
        A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.
        Throws:
        StripeException

      • create

        public static WebhookEndpoint create​(java.util.Map<java.lang.String,​java.lang.Object> params,
                                     RequestOptions options)
                              throws StripeException
        A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.
        Throws:
        StripeException

      • create

        public static WebhookEndpoint create​(WebhookEndpointCreateParams params)
                              throws StripeException
        A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.
        Throws:
        StripeException

      • create

        public static WebhookEndpoint create​(WebhookEndpointCreateParams params,
                                     RequestOptions options)
                              throws StripeException
        A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.
        Throws:
        StripeException

      • getApiVersion

        public java.lang.String getApiVersion()
        The API version events are rendered as for this webhook endpoint.

      • getApplication

        public java.lang.String getApplication()
        The ID of the associated Connect application.

      • getCreated

        public java.lang.Long getCreated()
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • getDeleted

        public java.lang.Boolean getDeleted()
        Always true for a deleted object.

      • getDescription

        public java.lang.String getDescription()
        An optional description of what the webhook is used for.

      • getEnabledEvents

        public java.util.List<java.lang.String> getEnabledEvents()
        The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.

      • getLivemode

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

      • getObject

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

        Equal to webhook_endpoint.

      • getSecret

        public java.lang.String getSecret()
        The endpoint's secret, used to generate webhook signatures. Only returned at creation.

      • getStatus

        public java.lang.String getStatus()
        The status of the webhook. It can be enabled or disabled.

      • getUrl

        public java.lang.String getUrl()
        The URL of the webhook endpoint.

      • setApiVersion

        public void setApiVersion​(java.lang.String apiVersion)
        The API version events are rendered as for this webhook endpoint.

      • setApplication

        public void setApplication​(java.lang.String application)
        The ID of the associated Connect application.

      • setCreated

        public void setCreated​(java.lang.Long created)
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • setDeleted

        public void setDeleted​(java.lang.Boolean deleted)
        Always true for a deleted object.

      • setDescription

        public void setDescription​(java.lang.String description)
        An optional description of what the webhook is used for.

      • setEnabledEvents

        public void setEnabledEvents​(java.util.List<java.lang.String> enabledEvents)
        The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.

      • setId

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

      • setLivemode

        public void setLivemode​(java.lang.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​(java.util.Map<java.lang.String,​java.lang.String> metadata)
        Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

      • setObject

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

        Equal to webhook_endpoint.

      • setSecret

        public void setSecret​(java.lang.String secret)
        The endpoint's secret, used to generate webhook signatures. Only returned at creation.

      • setStatus

        public void setStatus​(java.lang.String status)
        The status of the webhook. It can be enabled or disabled.

      • setUrl

        public void setUrl​(java.lang.String url)
        The URL of the webhook endpoint.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getId

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

      • getMetadata

        public java.util.Map<java.lang.String,​java.lang.String> getMetadata()
        Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
        Specified by:
        getMetadata in interface MetadataStore<WebhookEndpoint>