com.smartsheet.api.models

Class Webhook

java.lang.Object

com.smartsheet.api.models.IdentifiableModel<T>

com.smartsheet.api.models.NamedModel<Long>

com.smartsheet.api.models.Webhook

public class Webhook
extends NamedModel<Long>

Constructor Summary

Constructors

Constructor and Description
Webhook()

Method Summary

Modifier and Type	Method and Description
String	getApiClientId() Get the API client Id corresponding to third-party app that created the webhook.
String	getApiClientName() Get the API client name corresponding to third-party app that created the webhook.
String	getCallbackUrl() Get the HTTPS URL where callbacks will be sent
Date	getCreatedAt() Gets the time that the webhook was created.
String	getDisabledDetails() Get the details about the reason the webhook was disabled.
List<String>	getEvents() Get the array of events that are subscribed to
Date	getModifiedAt() Get the time that the webhook was last modified.
String	getScope() Get the scope of the subscription.
Long	getScopeObjectId() Get the Id of the object that is subscripted to
String	getSharedSecret() Get the shared secret for this webhook, randomly generated by Smartsheet
WebhookStats	getStats() Get the statistics for this webhook.
WebhookStatus	getStatus() Get the webhook status
Integer	getVersion() Get the webhook version.
Boolean	isEnabled() Get flag indicating whether the webhook is on(true) or off(false)
Webhook	setApiClientId(String apiClientId) Set the API client Id corresponding to third-party app that created the webhook.
Webhook	setApiClientName(String apiClientName) Set the API client name corresponding to third-party app that created the webhook.
Webhook	setCallbackUrl(String callbackUrl) Set the HTTPS URL where callbacks will be sent
Webhook	setCreatedAt(Date createdAt) Set the time the webhook was created.
Webhook	setDisabledDetails(String disabledDetails) Set the details about the reason the webhook was disabled.
Webhook	setEnabled(Boolean enabled) Set flag indicating whether the webhook is on or off.
Webhook	setEvents(List<String> events) Set the array of events that are subscribed to
Webhook	setModifiedAt(Date modifiedAt) Set the time that the webhook was last modified.
Webhook	setScope(String scope) Set the scope of the subscription
Webhook	setScopeObjectId(Long scopeObjectId) Set the Id of the object that is subscribed to
Webhook	setSharedSecret(String sharedSecret) Set the shared secret for this webhook
Webhook	setStats(WebhookStats stats) Set the statistics for this webhook.
Webhook	setStatus(WebhookStatus status) Set the webhook status
Webhook	setVersion(Integer version) Set the webhook version

Methods inherited from class com.smartsheet.api.models.NamedModel

getName, setName

Methods inherited from class com.smartsheet.api.models.IdentifiableModel

equals, getId, hashCode, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

Webhook

public Webhook()

Method Detail

getApiClientId

public String getApiClientId()

Get the API client Id corresponding to third-party app that created the webhook.

Returns:

apiClientId

setApiClientId

public Webhook setApiClientId(String apiClientId)

Set the API client Id corresponding to third-party app that created the webhook.

Parameters:

apiClientId -

getApiClientName

public String getApiClientName()

Get the API client name corresponding to third-party app that created the webhook.

Returns:

apiClientName;

setApiClientName

public Webhook setApiClientName(String apiClientName)

Set the API client name corresponding to third-party app that created the webhook.

Parameters:

apiClientName -

getScope

public String getScope()

Get the scope of the subscription.

Returns:

scope

setScope

public Webhook setScope(String scope)

Set the scope of the subscription

Parameters:

scope -

getScopeObjectId

public Long getScopeObjectId()

Get the Id of the object that is subscripted to

Returns:

scopeObjectId

setScopeObjectId

public Webhook setScopeObjectId(Long scopeObjectId)

Set the Id of the object that is subscribed to

Parameters:

scopeObjectId -

getEvents

public List<String> getEvents()

Get the array of events that are subscribed to

Returns:

events

setEvents

public Webhook setEvents(List<String> events)

Set the array of events that are subscribed to

Parameters:

events -

getCallbackUrl

public String getCallbackUrl()

Get the HTTPS URL where callbacks will be sent

Returns:

setCallbackUrl

public Webhook setCallbackUrl(String callbackUrl)

Set the HTTPS URL where callbacks will be sent

Parameters:

callbackUrl -

getSharedSecret

public String getSharedSecret()

Get the shared secret for this webhook, randomly generated by Smartsheet

Returns:

sharedSecret

setSharedSecret

public Webhook setSharedSecret(String sharedSecret)

Set the shared secret for this webhook

Parameters:

sharedSecret -

isEnabled

public Boolean isEnabled()

Get flag indicating whether the webhook is on(true) or off(false)

Returns:

enabled

setEnabled

public Webhook setEnabled(Boolean enabled)

Set flag indicating whether the webhook is on or off.

Parameters:

enabled -

getStatus

public WebhookStatus getStatus()

Get the webhook status

Returns:

status

setStatus

public Webhook setStatus(WebhookStatus status)

Set the webhook status

Parameters:

status -

getDisabledDetails

public String getDisabledDetails()

Get the details about the reason the webhook was disabled.

Returns:

disabledDetails

setDisabledDetails

public Webhook setDisabledDetails(String disabledDetails)

Set the details about the reason the webhook was disabled.

Parameters:

disabledDetails -

getVersion

public Integer getVersion()

Get the webhook version.

Returns:

version

setVersion

public Webhook setVersion(Integer version)

Set the webhook version

Parameters:

version -

getStats

public WebhookStats getStats()

Get the statistics for this webhook.

Returns:

stats

setStats

public Webhook setStats(WebhookStats stats)

Set the statistics for this webhook.

Parameters:

stats -

getCreatedAt

public Date getCreatedAt()

Gets the time that the webhook was created.

Returns:

createdAt

setCreatedAt

public Webhook setCreatedAt(Date createdAt)

Set the time the webhook was created.

Parameters:

createdAt -

getModifiedAt

public Date getModifiedAt()

Get the time that the webhook was last modified.

Returns:

modifiedAt

setModifiedAt

public Webhook setModifiedAt(Date modifiedAt)

Set the time that the webhook was last modified.

Parameters:

modifiedAt -