Package com.smartsheet.api.models

Class Webhook

  • public class Webhook
extends NamedModel<java.lang.Long>

    • Constructor Detail

      • Webhook

        public Webhook()

    • Method Detail

      • getApiClientId

        public java.lang.String getApiClientId()
        Get the API client ID corresponding to third-party app that created the webhook.
        Returns:
        apiClientId

      • setApiClientId

        public Webhook setApiClientId​(java.lang.String apiClientId)
        Set the API client ID corresponding to third-party app that created the webhook.

      • getScopeObjectId

        public java.lang.Long getScopeObjectId()
        Get the ID of the object that is subscripted to
        Returns:
        scopeObjectId

      • setScopeObjectId

        public Webhook setScopeObjectId​(java.lang.Long scopeObjectId)
        Set the ID of the object that is subscribed to

      • getApiClientName

        public java.lang.String getApiClientName()
        Get the API client name corresponding to third-party app that created the webhook.
        Returns:
        apiClientName;

      • setApiClientName

        public Webhook setApiClientName​(java.lang.String apiClientName)
        Set the API client name corresponding to third-party app that created the webhook.

      • getCallbackUrl

        public java.lang.String getCallbackUrl()
        Get the HTTPS URL where callbacks will be sent

      • setCallbackUrl

        public Webhook setCallbackUrl​(java.lang.String callbackUrl)
        Set the HTTPS URL where callbacks will be sent

      • getCreatedAt

        public java.util.Date getCreatedAt()
        Gets the time that the webhook was created.
        Returns:
        createdAt

      • setCreatedAt

        public Webhook setCreatedAt​(java.util.Date createdAt)
        Set the time the webhook was created.

      • getDisabledDetails

        public java.lang.String getDisabledDetails()
        Get the details about the reason the webhook was disabled.
        Returns:
        disabledDetails

      • setDisabledDetails

        public Webhook setDisabledDetails​(java.lang.String disabledDetails)
        Set the details about the reason the webhook was disabled.

      • isEnabled

        public java.lang.Boolean isEnabled()
        Get flag indicating whether the webhook is on(true) or off(false)
        Returns:
        enabled

      • setEnabled

        public Webhook setEnabled​(java.lang.Boolean enabled)
        Set flag indicating whether the webhook is on or off.

      • getEvents

        public java.util.List<java.lang.String> getEvents()
        Get the array of events that are subscribed to
        Returns:
        events

      • setEvents

        public Webhook setEvents​(java.util.List<java.lang.String> events)
        Set the array of events that are subscribed to

      • getModifiedAt

        public java.util.Date getModifiedAt()
        Get the time that the webhook was last modified.
        Returns:
        modifiedAt

      • setModifiedAt

        public Webhook setModifiedAt​(java.util.Date modifiedAt)
        Set the time that the webhook was last modified.

      • setName

        public Webhook setName​(java.lang.String name)
        Provide an 'override' of setName (returns Webhook not NamedModel)
        Overrides:
        setName in class NamedModel<java.lang.Long>
        Parameters:
        name - the new name

      • getScope

        public java.lang.String getScope()
        Get the scope of the subscription.
        Returns:
        scope

      • setScope

        public Webhook setScope​(java.lang.String scope)
        Set the scope of the subscription

      • getSharedSecret

        public java.lang.String getSharedSecret()
        Get the shared secret for this webhook, randomly generated by Smartsheet
        Returns:
        sharedSecret

      • setSharedSecret

        public Webhook setSharedSecret​(java.lang.String sharedSecret)
        Set the shared secret for this webhook

      • getStats

        public WebhookStats getStats()
        Get the statistics for this webhook.
        Returns:
        stats

      • setStats

        public Webhook setStats​(WebhookStats stats)
        Set the statistics for this webhook.

      • getStatus

        public WebhookStatus getStatus()
        Get the webhook status
        Returns:
        status

      • getSubscope

        public WebhookSubscope getSubscope()
        Get the webhook subscope
        Returns:
        subscope

      • getVersion

        public java.lang.Integer getVersion()
        Get the webhook version.
        Returns:
        version

      • setVersion

        public Webhook setVersion​(java.lang.Integer version)
        Set the webhook version