Request

Response

    Class HookDetails

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

    Contains the details of a webhook.

    [DataContract]
    public class HookDetails
    

    Inheritance

    object ← HookDetails

    Inherited Members

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

    Constructors

    HookDetails()

    Initializes a new instance of the class.

    public HookDetails()
    

    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 ?

    CallbackUrl

    The URL to send notifications to when the event is triggered.

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

    Property Value

    string

    CallbackWithEventPayloadOnly

    true - The callback request payload will only contain information about the event. It will not contain any information about the webhook.

    false - The callback request payload will contain information about the event as well as the webhook.

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

    Property Value

    string

    CreatedBy

    The ID of the entity that created the webhook. It can be one of the following:

    • Client ID of an app: If created using a Client Credentials flow (two-legged OAuth).
    • User ID of a user: If created using an Authorization Code flow (three-legged OAuth).
    [DataMember(Name = "createdBy", EmitDefaultValue = false)]
    public string CreatedBy { get; set; }
    

    Property Value

    string

    CreatedDate

    The date and time when the webhook was created, formatted as an ISO 8601 date/time string.

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

    Property Value

    string

    CreatorType

    Indicates what type of an entity created the webhooks. Possible values:

    • O2User - Created by a user through an Authorization Code flow (three-legged OAuth).
    • Application - Created by an application using a Client Credentials flow (two-legged OAuth).
    [DataMember(Name = "creatorType", EmitDefaultValue = false)]
    public string CreatorType { get; set; }
    

    Property Value

    string

    Event

    The ID of the event the webhook monitors. See Supported Events for a full list of events and wildcard patterns.

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

    Property Value

    string

    HookExpiry

    The date and time when the webhook will expire, formatted as an ISO 8601 date/time string. A missing or null value indicates that the webhook will never expire.

    hookExpiry is returned only if it was specified when the webhook was created.

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

    Property Value

    string

    HookId

    The ID that uniquely identifies the webhook.

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

    Property Value

    string

    LastUpdatedDate

    The date and time when the webhook was last modified, formatted as an ISO 8601 date/time string.

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

    Property Value

    string

    Scope

    Gets or Sets Scope

    [DataMember(Name = "scope", EmitDefaultValue = false)]
    public HookDetailsScope Scope { get; set; }
    

    Property Value

    HookDetailsScope

    Self

    A link to itself.

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

    Property Value

    string

    Status

    Gets or Sets Status

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

    Property Value

    Status

    System

    The ID of the system the webhook applies to. For example data for Data Management. See Supported Events for a full list of systems.

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

    Property Value

    string

    Tenant

    The ID of the tenant from which the event originates.

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

    Property Value

    string

    Urn

    The URN of the webhook.

    [DataMember(Name = "urn", EmitDefaultValue = false)]
    public string Urn { 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.