Class Webhook

Namespace

Smartsheet.Api.Models

Assembly

smartsheet-csharp-sdk.dll

Represents the webhook object.

public class Webhook : NamedModel

Inheritance

object

IdentifiableModel

NamedModel

Webhook

Inherited Members

NamedModel.Name

IdentifiableModel.Id

IdentifiableModel.Equals(object)

IdentifiableModel.GetHashCode()

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ApiClientId

Get the API Client Id corresponding to third-party app that created the Webhook.

public string ApiClientId { get; set; }

Property Value

string

the Client Id

ApiClientName

Get the API Client Name corresponding to third-party app that created the Webhook.

public string ApiClientName { get; set; }

Property Value

string

the Client Name

CallbackUrl

Get the HTTPS URL where callbacks will be sent.

public string CallbackUrl { get; set; }

Property Value

string

the URL

CreatedAt

Gets the Time that the webhook was created.

public DateTime? CreatedAt { get; set; }

Property Value

DateTime?

the DateTime

DisabledDetails

Get the details about the reason the Webhook was disabled.

public string DisabledDetails { get; set; }

Property Value

string

the details

Enabled

Get the Flag indicating whether the Webhook is on (true) or off (false).

public bool? Enabled { get; set; }

Property Value

bool?

the enabled flag

Events

Get the Array of the events that are subscribed to.

public IList<string> Events { get; set; }

Property Value

IList<string>

the string array

ModifiedAt

Gets the time that the webhook was modified.

public DateTime? ModifiedAt { get; set; }

Property Value

DateTime?

the DateTime

Scope

Get the Scope of the subscription.

public string Scope { get; set; }

Property Value

string

the Scope

ScopeObjectId

Get the ID of the object that is subscribed to.

public long? ScopeObjectId { get; set; }

Property Value

long?

the ScopeObjectId

SharedSecret

Get the Shared secret for this webhook, randomly generated by Smartsheet.

public string SharedSecret { get; set; }

Property Value

string

the shared secret

Stats

Get the statistics for this webhook.

public WebhookStats Stats { get; set; }

Property Value

WebhookStats

the WebhookStats

Status

Get the Webhook status.

public WebhookStatus? Status { get; set; }

Property Value

WebhookStatus?

the status

Subscope

Get the webhook subscope.

public WebhookSubscope Subscope { get; set; }

Property Value

WebhookSubscope

the subscope

Version

Get the webhook version.

public int? Version { get; set; }

Property Value

int?

the version

See Also

Webhook Object Help