Class HookPayload
Namespace: Autodesk.Webhooks.Model
Assembly: Autodesk.Webhooks.dll
Specifies the details of a webhook to be created.
[DataContract]
public class HookPayload
Inheritance
Inherited Members
object.Equals(object) , object.Equals(object, object) , object.GetHashCode() , object.GetType() , object.MemberwiseClone() , object.ReferenceEquals(object, object) , object.ToString()
Constructors
HookPayload()
Initializes a new instance of the
public HookPayload()
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
CallbackWithEventPayloadOnly
true
- The callback request payload must only contain information about the event. It must not contain any information about the webhook.
false
- (Default) The callback request payload must contain information about the event as well as the webhook.
[DataMember(Name = "callbackWithEventPayloadOnly", EmitDefaultValue = false)]
public bool? CallbackWithEventPayloadOnly { 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
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
HookExpiry
The date and time the webhook will expire, formatted as an ISO 8601 date/time string. If you do not specify this attribute or set it to null, the webhook will never expire.
[DataMember(Name = "hookExpiry", EmitDefaultValue = false)]
public string HookExpiry { get; set; }
Property Value
HubId
The ID of the hub that contains the entity that you want to monitor. Specify this attribute if the user calling this operation is a member of a large number of projects.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.
. For example, an Account ID of c8b0c73d-3ae9
translates to a hub ID of b.c8b0c73d-3ae9
.
[DataMember(Name = "hubId", EmitDefaultValue = false)]
public string HubId { get; set; }
Property Value
ProjectId
The ID of the project that contains the entity that you want to monitor Specify this attribute if the user calling this operation is a member of a large number of projects.
BIM 360 and ACC project IDs are different to Data Management project IDs. To convert a BIM 360 and ACC project IDs to Data Management project IDs, prefix the BIM 360 or ACC Project ID with b.
. For example, a project ID of c8b0c73d-3ae9
translates to a project ID of b.c8b0c73d-3ae9
.
[DataMember(Name = "projectId", EmitDefaultValue = false)]
public string ProjectId { get; set; }
Property Value
Scope
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 = "scope", EmitDefaultValue = false)]
public object Scope { get; set; }
Property Value
Tenant
The tenant associated with the event. If specified on the webhook, the event’s tenant must match the webhook’s tenant.
[DataMember(Name = "tenant", EmitDefaultValue = false)]
public string Tenant { get; set; }
Property Value
Methods
ToString()
Returns the string presentation of the object
public override string ToString()
Returns
A string representation of the object.