Webhook Filter Samples

This page details valid sample configurations for the webhook filter for each of the supported data types, and also objects.

Text/strings

Sample Json

Copy

  "text" : "demo",
  "text2" : "sample text"
}

Filter configuration

To configure a filter that matches when the property 'text' has the value 'demo' enter the following values into the respective columns:

Image showing a filter for the text data type

Json path:

/text

Expected Value:

demo

The Expected Value should be entered without quotes.

Numbers

Sample Json

Copy

  "number_neg" : -1234567,
  "number_pos" : 123456,
  "float" : 123.456
}

The following values should be entered into the respective columns.

Image showing a filter for the number data type

Property 1

Json path:

/number_neg

Expected Value:

-1234567

Property 2

Json path:

/number_pos

Expected Value:

123456

  • Decimal numbers such as the 'float' property in the above example are not supported and will cause an error.

  • The largest number supported is: 18446744073709551615

    If a number bigger than this number is used the largest number is used instead.

  • The smallest number supported is: -9223372036854775808

    If a number smaller than this number is used the smallest number is used instead.

Bools

Sample Json

Copy

    "test" : true,
    "test2" : false
}

The Expected Value column is not case sensitive so both examples listed below are valid.

Image showing a webhooks filter for the bool data type

Property 1

Json path:

/test

Expected Value:

true

Property 2

Json path:

/test2

Expected Value:

FALSE

Nulls

Sample Json

Copy

    "test" : null
}

Null is not case sensitive.

Image showing a filter for the null data type

Json path:

/test

Expected Value:

null

Objects

Sample Json

Copy

    "invoice" : {
        "id" : 12345,
        "data": {
            "title" : "moyaware",
            "payed" : true
        }
    }
}

Entering objects into the Json path is similar to the structure of folder paths. The Json path is case sensitive.

Image showing the webhook filter configuration for an object

Property 1

Json path:

/invoice/id

Expected Value:

12345

Property 2

Json path:

/invoice/data/title

Expected Value:

moyaware

Property 3

Json path:

/invoice/data/payed

Expected Value:

true