Name

Description

Type

Additional information

parameters

Collection of ParametersDetailsUpdate
name

The name of the web-hook

string

Required

url

The url that the web hook will call

string
event_type

Event type

TypesUserApiEventTypes
format

Web hook format

UserApiEventFormatTypes
is_active

Is this web-hook active or not

boolean
is_custom_only

Whether this webhook fires only for custom events

boolean
stateid

Web hook state (deprecated - please use the is_active flag)

TypesStateTypes