Interface: HookDetails
Defined in: model/hookDetails.ts:10
Contains the details of a webhook.
Export
HookDetails
Properties
__self__?
optional
__self__:string
Defined in: model/hookDetails.ts:128
A link to itself.
Memberof
HookDetails
autoReactivateHook?
optional
autoReactivateHook:boolean
Defined in: model/hookDetails.ts:88
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.
Memberof
HookDetails
callbackUrl?
optional
callbackUrl:string
Defined in: model/hookDetails.ts:30
The URL to send notifications to when the event is triggered.
Memberof
HookDetails
callbackWithEventPayloadOnly?
optional
callbackWithEventPayloadOnly:string
Defined in: model/hookDetails.ts:122
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.
Memberof
HookDetails
createdBy?
optional
createdBy:string
Defined in: model/hookDetails.ts:39
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).
Memberof
HookDetails
createdDate?
optional
createdDate:string
Defined in: model/hookDetails.ts:51
The date and time when the webhook was created, formatted as an ISO 8601 date/time string.
Memberof
HookDetails
creatorType?
optional
creatorType:string
Defined in: model/hookDetails.ts:72
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).
Memberof
HookDetails
event?
optional
event:string
Defined in: model/hookDetails.ts:45
The ID of the event the webhook monitors. See Supported Events for a full list of events and wildcard patterns.
Memberof
HookDetails
hookAttribute?
optional
hookAttribute:object
Defined in: model/hookDetails.ts:102
Custom metadata which will be less than 1KB in size.
Memberof
HookDetails
hookExpiry?
optional
hookExpiry:string
Defined in: model/hookDetails.ts:96
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.
Memberof
HookDetails
hookId?
optional
hookId:string
Defined in: model/hookDetails.ts:16
The ID that uniquely identifies the webhook.
Memberof
HookDetails
lastUpdatedDate?
optional
lastUpdatedDate:string
Defined in: model/hookDetails.ts:57
The date and time when the webhook was last modified, formatted as an ISO 8601 date/time string.
Memberof
HookDetails
scope?
optional
scope:HookDetailsScope
Defined in: model/hookDetails.ts:108
Memberof
HookDetails
status?
optional
status:Status
Defined in: model/hookDetails.ts:78
Memberof
HookDetails
system?
optional
system:string
Defined in: model/hookDetails.ts:63
The ID of the system the webhook applies to. For example data
for Data Management. See Supported Events for a full list of systems.
Memberof
HookDetails
tenant?
optional
tenant:string
Defined in: model/hookDetails.ts:23
The ID of the tenant from which the event originates.
Memberof
HookDetails
urn?
optional
urn:string
Defined in: model/hookDetails.ts:114
The URN of the webhook.
Memberof
HookDetails