apiVersion
latest
and default
.
The default setting is default
.enabled
true
.address
POST
request body. The full event details are included and can be used directly after parsing the JSON into an Event object.transportType
HTTP
or OAUTH
.
The default is HTTP
.
Refer to transport type and attributes for more information.POST/webhooks
request creates a Webhook for three different event types:transportType
of HTTP
is returned in the response.HTTP
was not explicitly passed as the transportType
in the above request, the userName
and password
parameters within the authentication
hash table were still accepted and returned in the response. This is because HTTP
is the default setting.transportType
is HTTP
by default, so it's not required to specify this parameter in the request. Whether you explicitly set the parameter to HTTP
or whether you don't provide a value at all, you can still use the authentication
hash table to provide a username
and password
. These values configure basic authentication for webhook callback endpoints.authentication
hash table is only accepted in the request and displayed in the response when transportType
is HTTP
.transportType
parameter to OAUTH
. Doing so means the callback is always accompanied by a valid bearer token.OAUTH
, then you must provide the tokenEndPoint
, clientID
, and clientSecret
within the oauth
hash table.oauth
hash table is only accepted in the request and displayed in the response when transportType
is OAUTH
.tokenEndPoint
is used to exchange an authorization grant for an access token. The clientID
is issued to you during the registration process. The clientSecret
is stored in encrypted format, but it is decrypted when exposed through the API. This is also true for the optional password
parameter within oauth
.