Interface BTWebhookParams

Export

Interface

BTWebhookParams

Hierarchy

  • BTWebhookParams

Properties

clientId? companyId? data? description? documentId? elementId? events? externalSessionId? filter? folderId? id? isTransient? linkDocumentId? options? partId? projectId? url? userId? versionId? workspaceId?

Properties

Optional clientId

clientId?: string

Memberof

BTWebhookParams

Optional companyId

companyId?: string

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

Memberof

BTWebhookParams

Optional data

data?: string

Memberof

BTWebhookParams

Optional description

description?: string

Memberof

BTWebhookParams

Optional documentId

documentId?: string

Memberof

BTWebhookParams

Optional elementId

elementId?: string

Memberof

BTWebhookParams

Optional events

events?: string[]

List of events for which webhook callback is invoked.

Memberof

BTWebhookParams

Optional externalSessionId

externalSessionId?: string

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

Memberof

BTWebhookParams

Optional filter

filter?: string

Memberof

BTWebhookParams

Optional folderId

folderId?: string

Memberof

BTWebhookParams

Optional id

id?: string

Memberof

BTWebhookParams

Optional isTransient

isTransient?: boolean

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

Memberof

BTWebhookParams

Optional linkDocumentId

linkDocumentId?: string

Memberof

BTWebhookParams

Optional options

options?: BTWebhookOptions

Memberof

BTWebhookParams

Optional partId

partId?: string

Memberof

BTWebhookParams

Optional projectId

projectId?: string

Memberof

BTWebhookParams

Optional url

url?: string

Memberof

BTWebhookParams

Optional userId

userId?: string

Memberof

BTWebhookParams

Optional versionId

versionId?: string

Memberof

BTWebhookParams

Optional workspaceId

workspaceId?: string

Memberof

BTWebhookParams

Settings

Member Visibility

Theme

Generated using TypeDoc