Interface BTWebhookInfo

Export

Interface

BTWebhookInfo

Hierarchy

  • BTWebhookInfo

Properties

companyId? createdBy? data? description? droppedEventCount? events? externalSessionId? filter? folderId? href? id? isTransient? name? options? projectId? url? viewRef?

Properties

Optional companyId

companyId?: string

Company admins can register webhooks to listen to all company events.

Memberof

BTWebhookInfo

Optional createdBy

createdBy?: BTUserSummaryInfo

Memberof

BTWebhookInfo

Optional data

data?: string

Memberof

BTWebhookInfo

Optional description

description?: string

Memberof

BTWebhookInfo

Optional droppedEventCount

droppedEventCount?: number

Memberof

BTWebhookInfo

Optional events

events?: string[]

List of events for which webhook callback is invoked.

Memberof

BTWebhookInfo

Optional externalSessionId

externalSessionId?: string

Applications can pass this parameter as X-Session-ID with every REST call to distinguish webhooks triggered by self.

Memberof

BTWebhookInfo

Optional filter

filter?: string

Memberof

BTWebhookInfo

Optional folderId

folderId?: string

Memberof

BTWebhookInfo

Optional href

href?: string

URI to fetch complete information of the resource.

Memberof

BTWebhookInfo

Optional id

id?: string

Id of the resource.

Memberof

BTWebhookInfo

Optional isTransient

isTransient?: boolean

Transient webhooks are automatically cleaned up after a period of inactivity.

Memberof

BTWebhookInfo

Optional name

name?: string

Name of the resource.

Memberof

BTWebhookInfo

Optional options

options?: BTWebhookOptions

Memberof

BTWebhookInfo

Optional projectId

projectId?: string

Memberof

BTWebhookInfo

Optional url

url?: string

Memberof

BTWebhookInfo

Optional viewRef

viewRef?: string

URI to visualize the resource in a webclient if applicable.

Memberof

BTWebhookInfo

Settings

Member Visibility

Theme

Generated using TypeDoc