CHEQROOM

Class: WebHook

WebHook

new WebHook()

webhook.js, line 33

WebHook describes a webhook which can trigger on certain events (signals)

Properties:
Name Type Description
name string

the name
address string

the url which will be called
topic string

the topic name ('item.changelocation', 'item.changegeo', 'item.expire', ...)
hookFields string

the fields which should be fetched from the db (default: `, location., items., customer.)
format string

the output format (only json is supported)
created Moment

the creation date of the webhook
modified Moment

the modified date of the webhook
enabled boolean

whether or not the webhook is enabled
log10 array

the last 10 logs of the webhook
fails int

the number of consequtive fails
minutes int

only for due and overdue webhooks, non-negative

Extends

Methods

canDelete(){promise}

webhook.js, line 149

Checks via the api if we can delete the WebHook document

inherited create(skipRead){promise}

document.js, line 132

Creates an object by the default api.create

Name Type Description
skipRead

skips reading the response via _fromJson (false)

inherited delete(){promise}

document.js, line 172

Deletes an object by the default api.delete

inherited discardChanges(){promise}

document.js, line 87

Discards any changes made to the object from the previously loaded raw response or resets it when no old raw response was found

inherited existsInDb(){boolean}

document.js, line 45

Checks if the document exists in the database

inherited get(_fields){promise}

document.js, line 113

Gets an object by the default api.get

Name Type Description
_fields

inherited isDirty(){boolean}

document.js, line 66

Checks if the object needs to be saved We don't check any of the keyvalues (or comments, attachments) here

isEmpty(){boolean}

webhook.js, line 114

Checks if the object is empty, it never is

isValid(){boolean}

webhook.js, line 97

Checks if the webhook has any validation errors

isValidAddress(){Boolean}

webhook.js, line 83

Checks if address is valid

isValidName(){Boolean}

webhook.js, line 72

Checks if name is valid

inherited reload(_fields){promise}

document.js, line 98

Reloads the object from db

Name Type Description
_fields

inherited reset(){promise}

document.js, line 34

Resets the object

inherited update(skipRead){promise}

document.js, line 152

Updates an object by the default api.update

Name Type Description
skipRead

skips reading the response via _fromJson (false)