Webhook plug-in structure
- Configuring a Webhook event source
- An event source that receives WebhookEvent type events can be configured in
three different ways:
- GenericHMAC
- When configuring a Generic HMAC type event source, you need to
specify the following parameters:
- Secret
-
- Type: string
- minlength: 1
- maxlength: 1000
- Required
- isPassword
- Algorithm
-
- Type: string
- minlength: 1
- maxlength: 1000
- Required
- HeaderName
-
- Type: string
- minlength: 1
- maxlength: 1000
- Required
- IPNetMask
-
- Type: list
- minlength: 1
- maxlength: 1000
- Generic
- When configuring a Generic type event source you can specify:
- IPNetMask
-
- Type: list
- minlength: 1
- maxlength: 1000
- Github
- When configuring a Github type event source, you need to specify the
following mandatory parameter:
- Secret
-
- Type: string
- minlength: 1
- maxlength: 1000
- Required
- isPassword
- IPNetMask
-
- Type: list
- minlength: 1
- maxlength: 1000
- Webhook event condition
- WebhookEvent type event conditions can be configured in job streams specifying
the following required properties:
- Name
- Type
- Event source
Note: When defining event conditions, all the relative fields are case insensitiveYou can also specify any number of properties that filter the events received from the event source:- Method
- Type: string
- Operator:
EQ("=")
orNE("!=")
- minlength: 1
- maxlength: false
- Wildcard allowed: false
- Multiple filters: true
- Single predicate: false
- Case sensitive: false
- Values: you can choose one or more:
POST
GET
DELETE
PUT
OPTIONS
HEAD
CONNECT
PATCH
TRACE
- Headers
- Type: map
- Operator:
KEY_VALUE("keyvalue")
- minlength: 1
- maxlength: 1000
- Wildcard allowed: true
- Multiple filters: false
- Single predicate: false
- Case sensitive: false
- Values: {HeaderName[,Headervalue]}
- Parameters
- Type: map
- Operator:
KEY_VALUE("keyvalue")
- minlength: 1
- maxlength: 1000
- Wildcard allowed: true
- Multiple filters: false
- Single predicate: false
- Case sensitive: false
- Values: {ParamName[,Paramvalue]}
- ContentType
- Type: string
- Operator:
EQ("=")
orNE("!=")
- minlength: 1
- maxlength: false
- Wildcard allowed: true
- Multiple filters: true
- Single predicate: false
- Case sensitive: false
- Values: application/json
- Body
- Type: json
- Operator:
JSONATA("jsonata")
- minlength: 1
- maxlength: 1000
- Wildcard allowed: false
- Multiple filters: false
- Single predicate: true
- Case sensitive: false
- Values: jsonataExpression