Request

Response

    Class ModifyHookPayload

    Namespace: Autodesk.Webhooks.Model
    Assembly: Autodesk.Webhooks.dll

    Specifies the details of a webhook to be updated.

    [DataContract]
    public class ModifyHookPayload
    

    Inheritance

    object ← ModifyHookPayload

    Inherited Members

    object.Equals(object) , object.Equals(object, object) , object.GetHashCode() , object.GetType() , object.MemberwiseClone() , object.ReferenceEquals(object, object) , object.ToString()

    Constructors

    ModifyHookPayload()

    Initializes a new instance of the class.

    public ModifyHookPayload()
    

    Properties

    AutoReactivateHook

    true - Automatically reactivate the webhook if it becomes inactive.

    false - (Default) Do not reactivate the webhook if it becomes inactive.

    See Event Delivery Guarantees for more information on how the webhooks service handles reactivation.

    [DataMember(Name = "autoReactivateHook", EmitDefaultValue = false)]
    public bool? AutoReactivateHook { get; set; }
    

    Property Value

    bool ?

    Filter

    A Jsonpath expression that you can use to filter the callbacks you receive.

    See Callback Filtering for more information.

    [DataMember(Name = "filter", EmitDefaultValue = false)]
    public string Filter { get; set; }
    

    Property Value

    string

    HookAttribute

    Specifies the extent to which the event is monitored. For example, if the scope is folder, the webhooks service generates a notification for the specified event occurring in any sub folder or item within that folder.

    [DataMember(Name = "hookAttribute", EmitDefaultValue = false)]
    public object HookAttribute { get; set; }
    

    Property Value

    object

    HookExpiry

    The date and time the webhook will expire, formatted as an ISO 8601 date/time string. If you set this to null, the webhook will never expire.

    [DataMember(Name = "hookExpiry", EmitDefaultValue = false)]
    public string HookExpiry { get; set; }
    

    Property Value

    string

    Status

    Gets or Sets Status

    [DataMember(Name = "status", EmitDefaultValue = true)]
    public StatusRequest Status { get; set; }
    

    Property Value

    StatusRequest

    Token

    A secret token that is used to generate a hash signature, which is passed along with notification requests to the callback URL.

    See the Secret Token section in API Basics for more information.

    [DataMember(Name = "token", EmitDefaultValue = false)]
    public string Token { get; set; }
    

    Property Value

    string

    Methods

    ToString()

    Returns the string presentation of the object

    public override string ToString()
    

    Returns

    string

    A string representation of the object.