Interface

Webhook connection detailed information.

Since 1.0.11

Inheritance: WebhookConnectionDetailsWebhookConnection

Properties

Hide inherited properties
PropertyTypeNotes
connectionId
inherited
string

The unique id of the webhook connection.

string

The name of the webhook connection.

enabled
inherited
boolean

Indicates whether the webhook connection is enabled.

string

The alternative user for the "Run As" user for webhook execution.

itemId
inherited
string

The item id of the feature service webhook item.

managedWebhookIdstring

The managed webhook id of the service webhook.

secretstring

A secret key to be used when executing the service webhook.

username
inherited
string

The "Run As" user for webhook execution.

webhookActiveboolean

Indicates if the service webhook is currently active.

webhookChangeTypesWebhookConnectionChangeType[]

List of events that will trigger the associated service webhook.

webhookTypeWebhookConnectionType

The type of the webhook connection item.

connectionId

inheritedinherited
Interface Property
connectionId: string

The unique id of the webhook connection.

connectionName

inheritedinherited
Interface Property
connectionName: string

The name of the webhook connection.

enabled

inheritedinherited
Interface Property
enabled: boolean

Indicates whether the webhook connection is enabled.

fallbackUsername

optionalinheritedinherited
Interface Property
fallbackUsername: string

The alternative user for the "Run As" user for webhook execution.

itemId

inheritedinherited
Interface Property
itemId: string

The item id of the feature service webhook item.

managedWebhookId

optional
Interface Property
managedWebhookId: string

The managed webhook id of the service webhook.

Available if the service webhook was created and is managed by Workflow Manager.

secret

Interface Property
secret: string

A secret key to be used when executing the service webhook.

username

optionalinheritedinherited
Interface Property
username: string

The "Run As" user for webhook execution.

webhookActive

optional
Interface Property
webhookActive: boolean

Indicates if the service webhook is currently active.

Available if the service webhook is managed by Workflow Manager.

webhookChangeTypes

optional
Interface Property
webhookChangeTypes: WebhookConnectionChangeType[]

List of events that will trigger the associated service webhook.

Aavailable if the service webhook is managed by Workflow Manager.

webhookType

Interface Property
webhookType: WebhookConnectionType

The type of the webhook connection item.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.