Package com.stripe.model

Class WebhookEndpoint

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.WebhookEndpoint

All Implemented Interfaces:

HasId, MetadataStore<WebhookEndpoint>, StripeActiveObject, StripeObjectInterface

public class WebhookEndpoint
extends ApiResource
implements HasId, MetadataStore<WebhookEndpoint>

You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.

Most users configure webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints.

Related guide: Setting up webhooks

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
WebhookEndpoint()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static WebhookEndpoint	create(WebhookEndpointCreateParams params)	A webhook endpoint must have a url and a list of enabled_events.
static WebhookEndpoint	create(WebhookEndpointCreateParams params, RequestOptions options)	A webhook endpoint must have a url and a list of enabled_events.
static WebhookEndpoint	create(Map<String,Object> params)	A webhook endpoint must have a url and a list of enabled_events.
static WebhookEndpoint	create(Map<String,Object> params, RequestOptions options)	A webhook endpoint must have a url and a list of enabled_events.
WebhookEndpoint	delete()	You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.
WebhookEndpoint	delete(RequestOptions options)	You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.
WebhookEndpoint	delete(Map<String,Object> params)	You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.
WebhookEndpoint	delete(Map<String,Object> params, RequestOptions options)	You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.
boolean	equals(Object o)
String	getApiVersion()	The API version events are rendered as for this webhook endpoint.
String	getApplication()	The ID of the associated Connect application.
Long	getCreated()	Time at which the object was created.
Boolean	getDeleted()	Always true for a deleted object.
String	getDescription()	An optional description of what the webhook is used for.
List<String>	getEnabledEvents()	The list of events to enable for this endpoint.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getObject()	String representing the object's type.
String	getSecret()	The endpoint's secret, used to generate webhook signatures.
String	getStatus()	The status of the webhook.
String	getUrl()	The URL of the webhook endpoint.
int	hashCode()
static WebhookEndpointCollection	list(WebhookEndpointListParams params)	Returns a list of your webhook endpoints.
static WebhookEndpointCollection	list(WebhookEndpointListParams params, RequestOptions options)	Returns a list of your webhook endpoints.
static WebhookEndpointCollection	list(Map<String,Object> params)	Returns a list of your webhook endpoints.
static WebhookEndpointCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of your webhook endpoints.
static WebhookEndpoint	retrieve(String webhookEndpoint)	Retrieves the webhook endpoint with the given ID.
static WebhookEndpoint	retrieve(String webhookEndpoint, RequestOptions options)	Retrieves the webhook endpoint with the given ID.
static WebhookEndpoint	retrieve(String webhookEndpoint, WebhookEndpointRetrieveParams params, RequestOptions options)	Retrieves the webhook endpoint with the given ID.
static WebhookEndpoint	retrieve(String webhookEndpoint, Map<String,Object> params, RequestOptions options)	Retrieves the webhook endpoint with the given ID.
void	setApiVersion(String apiVersion)	The API version events are rendered as for this webhook endpoint.
void	setApplication(String application)	The ID of the associated Connect application.
void	setCreated(Long created)	Time at which the object was created.
void	setDeleted(Boolean deleted)	Always true for a deleted object.
void	setDescription(String description)	An optional description of what the webhook is used for.
void	setEnabledEvents(List<String> enabledEvents)	The list of events to enable for this endpoint.
void	setId(String id)	Unique identifier for the object.
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.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setObject(String object)	String representing the object's type.
void	setSecret(String secret)	The endpoint's secret, used to generate webhook signatures.
void	setStatus(String status)	The status of the webhook.
void	setUrl(String url)	The URL of the webhook endpoint.
WebhookEndpoint	update(WebhookEndpointUpdateParams params)	Updates the webhook endpoint.
WebhookEndpoint	update(WebhookEndpointUpdateParams params, RequestOptions options)	Updates the webhook endpoint.
WebhookEndpoint	update(Map<String,Object> params)	Updates the webhook endpoint.
WebhookEndpoint	update(Map<String,Object> params, RequestOptions options)	Updates the webhook endpoint.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, setResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

WebhookEndpoint

public WebhookEndpoint()

Method Details

create

public static WebhookEndpoint create(Map<String,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(Map<String,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

delete

public WebhookEndpoint delete()
                       throws StripeException

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

Throws:

StripeException

delete

public WebhookEndpoint delete(RequestOptions options)
                       throws StripeException

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

Throws:

StripeException

delete

public WebhookEndpoint delete(Map<String,Object> params)
                       throws StripeException

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

Throws:

StripeException

delete

public WebhookEndpoint delete(Map<String,Object> params,
 RequestOptions options)
                       throws StripeException

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

Throws:

StripeException

list

public static WebhookEndpointCollection list(Map<String,Object> params)
                                      throws StripeException

Returns a list of your webhook endpoints.

Throws:

StripeException

list

public static WebhookEndpointCollection list(Map<String,Object> params,
 RequestOptions options)
                                      throws StripeException

Returns a list of your webhook endpoints.

Throws:

StripeException

list

public static WebhookEndpointCollection list(WebhookEndpointListParams params)
                                      throws StripeException

Returns a list of your webhook endpoints.

Throws:

StripeException

list

public static WebhookEndpointCollection list(WebhookEndpointListParams params,
 RequestOptions options)
                                      throws StripeException

Returns a list of your webhook endpoints.

Throws:

StripeException

retrieve

public static WebhookEndpoint retrieve(String webhookEndpoint)
                                throws StripeException

Retrieves the webhook endpoint with the given ID.

Throws:

StripeException

retrieve

public static WebhookEndpoint retrieve(String webhookEndpoint,
 RequestOptions options)
                                throws StripeException

Retrieves the webhook endpoint with the given ID.

Throws:

StripeException

retrieve

public static WebhookEndpoint retrieve(String webhookEndpoint,
 Map<String,Object> params,
 RequestOptions options)
                                throws StripeException

Retrieves the webhook endpoint with the given ID.

Throws:

StripeException

retrieve

public static WebhookEndpoint retrieve(String webhookEndpoint,
 WebhookEndpointRetrieveParams params,
 RequestOptions options)
                                throws StripeException

Retrieves the webhook endpoint with the given ID.

Throws:

StripeException

update

public WebhookEndpoint update(Map<String,Object> params)
                       throws StripeException

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

Specified by:

update in interface MetadataStore<WebhookEndpoint>

Throws:

StripeException

update

public WebhookEndpoint update(Map<String,Object> params,
 RequestOptions options)
                       throws StripeException

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

Specified by:

update in interface MetadataStore<WebhookEndpoint>

Throws:

StripeException

update

public WebhookEndpoint update(WebhookEndpointUpdateParams params)
                       throws StripeException

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

Throws:

StripeException

update

public WebhookEndpoint update(WebhookEndpointUpdateParams params,
 RequestOptions options)
                       throws StripeException

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

Throws:

StripeException

getApiVersion

public String getApiVersion()

The API version events are rendered as for this webhook endpoint.

getApplication

public String getApplication()

The ID of the associated Connect application.

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getDeleted

public Boolean getDeleted()

Always true for a deleted object.

getDescription

public String getDescription()

An optional description of what the webhook is used for.

getEnabledEvents

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

String representing the object's type. Objects of the same type share the same value.

Equal to webhook_endpoint.

getSecret

public String getSecret()

The endpoint's secret, used to generate webhook signatures. Only returned at creation.

getStatus

public String getStatus()

The status of the webhook. It can be enabled or disabled.

getUrl

public String getUrl()

The URL of the webhook endpoint.

setApiVersion

public void setApiVersion(String apiVersion)

The API version events are rendered as for this webhook endpoint.

setApplication

public void setApplication(String application)

The ID of the associated Connect application.

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setDeleted

public void setDeleted(Boolean deleted)

Always true for a deleted object.

setDescription

public void setDescription(String description)

An optional description of what the webhook is used for.

setEnabledEvents

public void setEnabledEvents(List<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(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)

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(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(String secret)

The endpoint's secret, used to generate webhook signatures. Only returned at creation.

setStatus

public void setStatus(String status)

The status of the webhook. It can be enabled or disabled.

setUrl

public void setUrl(String url)

The URL of the webhook endpoint.

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

getMetadata

public Map<String,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>