Class Webhook

java.lang.Object

sendpost_java_sdk.Webhook

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-12-22T13:35:12.742682+05:30[Asia/Kolkata]",
           comments="Generator version: 7.13.0")
public class Webhook
extends Object

Webhook

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Webhook.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_CLICKED
static final String	SERIALIZED_NAME_CREATED
static final String	SERIALIZED_NAME_CREATED_BY
static final String	SERIALIZED_NAME_DELIVERED
static final String	SERIALIZED_NAME_DROPPED
static final String	SERIALIZED_NAME_ENABLED
static final String	SERIALIZED_NAME_HARD_BOUNCED
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_OPENED
static final String	SERIALIZED_NAME_PROCESSED
static final String	SERIALIZED_NAME_SENT
static final String	SERIALIZED_NAME_SMTP_DROPPED
static final String	SERIALIZED_NAME_SOFT_BOUNCED
static final String	SERIALIZED_NAME_SPAM
static final String	SERIALIZED_NAME_UNIQUE_CLICK
static final String	SERIALIZED_NAME_UNIQUE_OPEN
static final String	SERIALIZED_NAME_UNSUBSCRIBED
static final String	SERIALIZED_NAME_UPDATED_BY
static final String	SERIALIZED_NAME_URL

Constructor Summary

Constructors

Constructor	Description
Webhook()

Method Summary

Modifier and Type	Method	Description
Webhook	clicked(Boolean clicked)
Webhook	created(Long created)
Webhook	createdBy(Member createdBy)
Webhook	delivered(Boolean delivered)
Webhook	dropped(Boolean dropped)
Webhook	enabled(Boolean enabled)
boolean	equals(Object o)
static Webhook	fromJson(String jsonString)	Create an instance of Webhook given an JSON string
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
Boolean	getClicked()	Trigger webhook on email message link being clicked.
Long	getCreated()	UNIX epoch nano timestamp when the webhook was created.
Member	getCreatedBy()	Member who created the webhook
Boolean	getDelivered()	Trigger webhook on email message being delivered.
Boolean	getDropped()	Trigger webhook on email message being dropped.
Boolean	getEnabled()	Indicates if the webhook is active or paused.
Boolean	getHardBounced()	Trigger webhook on email message being hard bounced.
Integer	getId()	Unique ID for the webhook.
Boolean	getOpened()	Trigger webhook on email message being opened.
Boolean	getProcessed()	Trigger webhook on email message being processed.
Boolean	getSent()	Trigger webhook on email message being sent.
Boolean	getSmtpDropped()	Trigger webhook on email message being dropped by SMTP.
Boolean	getSoftBounced()	Trigger webhook on email message being soft bounced.
Boolean	getSpam()	Trigger webhook on email message being marked as spam.
Boolean	getUniqueClick()	Trigger webhook on unique email clicks.
Boolean	getUniqueOpen()	Trigger webhook on unique email opens.
Boolean	getUnsubscribed()	Trigger webhook on email message being unsubscribed.
Member	getUpdatedBy()	Member who updated the webhook
String	getUrl()	URL endpoint to which webhook calls need to be made.
Webhook	hardBounced(Boolean hardBounced)
int	hashCode()
Webhook	id(Integer id)
Webhook	opened(Boolean opened)
Webhook	processed(Boolean processed)
Webhook	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
Webhook	sent(Boolean sent)
void	setClicked(Boolean clicked)
void	setCreated(Long created)
void	setCreatedBy(Member createdBy)
void	setDelivered(Boolean delivered)
void	setDropped(Boolean dropped)
void	setEnabled(Boolean enabled)
void	setHardBounced(Boolean hardBounced)
void	setId(Integer id)
void	setOpened(Boolean opened)
void	setProcessed(Boolean processed)
void	setSent(Boolean sent)
void	setSmtpDropped(Boolean smtpDropped)
void	setSoftBounced(Boolean softBounced)
void	setSpam(Boolean spam)
void	setUniqueClick(Boolean uniqueClick)
void	setUniqueOpen(Boolean uniqueOpen)
void	setUnsubscribed(Boolean unsubscribed)
void	setUpdatedBy(Member updatedBy)
void	setUrl(String url)
Webhook	smtpDropped(Boolean smtpDropped)
Webhook	softBounced(Boolean softBounced)
Webhook	spam(Boolean spam)
String	toJson()	Convert an instance of Webhook to an JSON string
String	toString()
Webhook	uniqueClick(Boolean uniqueClick)
Webhook	uniqueOpen(Boolean uniqueOpen)
Webhook	unsubscribed(Boolean unsubscribed)
Webhook	updatedBy(Member updatedBy)
Webhook	url(String url)
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_ENABLED

public static final String SERIALIZED_NAME_ENABLED

See Also:

• Constant Field Values

SERIALIZED_NAME_URL

public static final String SERIALIZED_NAME_URL

See Also:

• Constant Field Values

SERIALIZED_NAME_PROCESSED

public static final String SERIALIZED_NAME_PROCESSED

See Also:

• Constant Field Values

SERIALIZED_NAME_DELIVERED

public static final String SERIALIZED_NAME_DELIVERED

See Also:

• Constant Field Values

SERIALIZED_NAME_DROPPED

public static final String SERIALIZED_NAME_DROPPED

See Also:

• Constant Field Values

SERIALIZED_NAME_SOFT_BOUNCED

public static final String SERIALIZED_NAME_SOFT_BOUNCED

See Also:

• Constant Field Values

SERIALIZED_NAME_HARD_BOUNCED

public static final String SERIALIZED_NAME_HARD_BOUNCED

See Also:

• Constant Field Values

SERIALIZED_NAME_OPENED

public static final String SERIALIZED_NAME_OPENED

See Also:

• Constant Field Values

SERIALIZED_NAME_CLICKED

public static final String SERIALIZED_NAME_CLICKED

See Also:

• Constant Field Values

SERIALIZED_NAME_UNSUBSCRIBED

public static final String SERIALIZED_NAME_UNSUBSCRIBED

See Also:

• Constant Field Values

SERIALIZED_NAME_SPAM

public static final String SERIALIZED_NAME_SPAM

See Also:

• Constant Field Values

SERIALIZED_NAME_SENT

public static final String SERIALIZED_NAME_SENT

See Also:

• Constant Field Values

SERIALIZED_NAME_SMTP_DROPPED

public static final String SERIALIZED_NAME_SMTP_DROPPED

See Also:

• Constant Field Values

SERIALIZED_NAME_UNIQUE_OPEN

public static final String SERIALIZED_NAME_UNIQUE_OPEN

See Also:

• Constant Field Values

SERIALIZED_NAME_UNIQUE_CLICK

public static final String SERIALIZED_NAME_UNIQUE_CLICK

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED

public static final String SERIALIZED_NAME_CREATED

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_BY

public static final String SERIALIZED_NAME_CREATED_BY

See Also:

• Constant Field Values

SERIALIZED_NAME_UPDATED_BY

public static final String SERIALIZED_NAME_UPDATED_BY

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

Webhook

public Webhook()

Method Details

id

public Webhook id(@Nullable
 Integer id)

getId

@Nullable
public Integer getId()

Unique ID for the webhook.

Returns:

id

setId

public void setId(@Nullable
 Integer id)

enabled

public Webhook enabled(@Nullable
 Boolean enabled)

getEnabled

@Nullable
public Boolean getEnabled()

Indicates if the webhook is active or paused.

Returns:

enabled

setEnabled

public void setEnabled(@Nullable
 Boolean enabled)

url

public Webhook url(@Nullable
 String url)

getUrl

@Nullable
public String getUrl()

URL endpoint to which webhook calls need to be made.

Returns:

url

setUrl

public void setUrl(@Nullable
 String url)

processed

public Webhook processed(@Nullable
 Boolean processed)

getProcessed

@Nullable
public Boolean getProcessed()

Trigger webhook on email message being processed.

Returns:

processed

setProcessed

public void setProcessed(@Nullable
 Boolean processed)

delivered

public Webhook delivered(@Nullable
 Boolean delivered)

getDelivered

@Nullable
public Boolean getDelivered()

Trigger webhook on email message being delivered.

Returns:

delivered

setDelivered

public void setDelivered(@Nullable
 Boolean delivered)

dropped

public Webhook dropped(@Nullable
 Boolean dropped)

getDropped

@Nullable
public Boolean getDropped()

Trigger webhook on email message being dropped.

Returns:

dropped

setDropped

public void setDropped(@Nullable
 Boolean dropped)

softBounced

public Webhook softBounced(@Nullable
 Boolean softBounced)

getSoftBounced

@Nullable
public Boolean getSoftBounced()

Trigger webhook on email message being soft bounced.

Returns:

softBounced

setSoftBounced

public void setSoftBounced(@Nullable
 Boolean softBounced)

hardBounced

public Webhook hardBounced(@Nullable
 Boolean hardBounced)

getHardBounced

@Nullable
public Boolean getHardBounced()

Trigger webhook on email message being hard bounced.

Returns:

hardBounced

setHardBounced

public void setHardBounced(@Nullable
 Boolean hardBounced)

opened

public Webhook opened(@Nullable
 Boolean opened)

getOpened

@Nullable
public Boolean getOpened()

Trigger webhook on email message being opened.

Returns:

opened

setOpened

public void setOpened(@Nullable
 Boolean opened)

clicked

public Webhook clicked(@Nullable
 Boolean clicked)

getClicked

@Nullable
public Boolean getClicked()

Trigger webhook on email message link being clicked.

Returns:

clicked

setClicked

public void setClicked(@Nullable
 Boolean clicked)

unsubscribed

public Webhook unsubscribed(@Nullable
 Boolean unsubscribed)

getUnsubscribed

@Nullable
public Boolean getUnsubscribed()

Trigger webhook on email message being unsubscribed.

Returns:

unsubscribed

setUnsubscribed

public void setUnsubscribed(@Nullable
 Boolean unsubscribed)

spam

public Webhook spam(@Nullable
 Boolean spam)

getSpam

@Nullable
public Boolean getSpam()

Trigger webhook on email message being marked as spam.

Returns:

spam

setSpam

public void setSpam(@Nullable
 Boolean spam)

sent

public Webhook sent(@Nullable
 Boolean sent)

getSent

@Nullable
public Boolean getSent()

Trigger webhook on email message being sent.

Returns:

sent

setSent

public void setSent(@Nullable
 Boolean sent)

smtpDropped

public Webhook smtpDropped(@Nullable
 Boolean smtpDropped)

getSmtpDropped

@Nullable
public Boolean getSmtpDropped()

Trigger webhook on email message being dropped by SMTP.

Returns:

smtpDropped

setSmtpDropped

public void setSmtpDropped(@Nullable
 Boolean smtpDropped)

uniqueOpen

public Webhook uniqueOpen(@Nullable
 Boolean uniqueOpen)

getUniqueOpen

@Nullable
public Boolean getUniqueOpen()

Trigger webhook on unique email opens.

Returns:

uniqueOpen

setUniqueOpen

public void setUniqueOpen(@Nullable
 Boolean uniqueOpen)

uniqueClick

public Webhook uniqueClick(@Nullable
 Boolean uniqueClick)

getUniqueClick

@Nullable
public Boolean getUniqueClick()

Trigger webhook on unique email clicks.

Returns:

uniqueClick

setUniqueClick

public void setUniqueClick(@Nullable
 Boolean uniqueClick)

created

public Webhook created(@Nullable
 Long created)

getCreated

@Nullable
public Long getCreated()

UNIX epoch nano timestamp when the webhook was created.

Returns:

created

setCreated

public void setCreated(@Nullable
 Long created)

createdBy

public Webhook createdBy(@Nullable
 Member createdBy)

getCreatedBy

@Nullable
public Member getCreatedBy()

Member who created the webhook

Returns:

createdBy

setCreatedBy

public void setCreatedBy(@Nullable
 Member createdBy)

updatedBy

public Webhook updatedBy(@Nullable
 Member updatedBy)

getUpdatedBy

@Nullable
public Member getUpdatedBy()

Member who updated the webhook

Returns:

updatedBy

setUpdatedBy

public void setUpdatedBy(@Nullable
 Member updatedBy)

putAdditionalProperty

public Webhook putAdditionalProperty(String key,
 Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - name of the property

value - value of the property

Returns:

the Webhook instance itself

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to Webhook

fromJson

public static Webhook fromJson(String jsonString)
                        throws IOException

Create an instance of Webhook given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of Webhook

Throws:

IOException - if the JSON string is invalid with respect to Webhook

toJson

public String toJson()

Convert an instance of Webhook to an JSON string

Returns:

JSON string