Documentation

Class

Webhook

Webhook(data)

Webhook Model
Constructor

# new Webhook(data)

Model constructor
Parameters:
Name Type Description
data WebhookLike

View Source model/Webhook.js, line 6

Classes

Webhook

Members

String

# authentication

The authentication value to use when calling the URI. Should be 'key=value'. In case of header, this should be 'headername=headervalue'. Only required when the AuthenticationType is anything other than 'none'.

View Source model/Webhook.js, line 71

String

# authenticationType

The authentication type to use when calling the URI. Can be 'none', 'header'. Required.

View Source model/Webhook.js, line 63

String

# createdBy

The id of the user who created this webhook config.

View Source model/Webhook.js, line 111

String

# createdOn

The date this webhook config was created.

View Source model/Webhook.js, line 103

# events

The event(s) that trigger the web hook. A comma-seperated list of events, for example 'user_added, user_deleted'. Required.

View Source model/Webhook.js, line 47

String

# id

The id of the webhook config.

View Source model/Webhook.js, line 79

Boolean

# isActive

Whether the web hook is currently active. Required.

View Source model/Webhook.js, line 55

String

# language

The language of the web hook message that will be sent to the receiver. Not required for custom web hooks.

View Source model/Webhook.js, line 40

String

# lastFailureReason

The most recent failure reason.

View Source model/Webhook.js, line 95

String

# name

The name of this webhook event. Required.

View Source model/Webhook.js, line 24

String

# receiverType

The type of the web hook. Can be 'custom', 'slack'.

View Source model/Webhook.js, line 87

String

# updatedBy

The id of the user who last modified this webhook config.

View Source model/Webhook.js, line 127

String

# updatedOn

The date this webhook was last modified.

View Source model/Webhook.js, line 119

String

# uri

The URI to call. Required.

View Source model/Webhook.js, line 32