WebhookConnectionSettings

The Webhook Data Source connection settings.

fields

• basicAuth nullable HttpBasicAuthSettings

  The HTTP basic authentication settings for the Webhook Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it's OK to test without HTTP Basic authentication, we recommend enabling it.

  The HTTP Basic authentication settings.

  • basicAuth.username non-null String

    Username for HTTP Basic authentication that must be included in the Authorization header when uploading new data.

  • basicAuth.password non-null String

    Password for HTTP Basic authentication that must be included in the Authorization header when uploading new data.

• columns nullable array of WebhookDataSourceColumn

  The additional columns for the Webhook Data Source table.

  A column in the Webhook Data Source's table.

  • columns.name non-null String

    The column name.

  • columns.jsonProperty non-null String

    The JSON property that the column will be derived from. For example, if you POST a JSON event like this:

    { "greeting": { "message": "hello, world" } }
    

    Then you can use the JSON property "greeting.message" to extract "hello, world" to a column.

  • columns.type non-null ColumnType

    The column type.

    The Propel data types.

    • BOOLEAN

      True or false.

    • STRING

      A variable-length string.

    • FLOAT

      A 32-bit signed double-precision floating point number.

    • DOUBLE

      A 64-bit signed double-precision floating point number.

    • INT8

      An 8-bit signed integer, with a minimum value of -2⁷ and a maximum value of 2⁷-1.

    • INT16

      A 16-bit signed integer, with a minimum value of -2¹⁵ and a maximum value of 2¹⁵-1.

    • INT32

      A 32-bit signed integer, with a minimum value of -2³¹ and a maximum value of 2³¹-1.

    • INT64

      A 64-bit signed integer, with a minimum value of -2⁶³ and a maximum value of 2⁶³-1.

    • DATE

      A date without a timestamp. For example, "YYYY-MM-DD".

    • TIMESTAMP

      A date with a timestamp. For example, "yyy-MM-dd HH:mm:ss".

    • JSON

      A JavaScript Object Notation (JSON) document.

  • columns.nullable non-null Boolean

    Whether the column's type is nullable or not.

• tenant nullable String

  The tenant ID column, if configured.

• timestamp non-null String

  The primary timestamp column.

• uniqueId nullable String

  The unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated.

• webhookUrl non-null String

  The Webhook URL for posting JSON events