Name

Description

Type

Additional information

id

Event id

integer
name

The name of the web-hook

string

Required

url

The customer url you want the web-hook to call and send parameters to

string
event_type

The event type id. detaits in the TypesUserApiEventTypes enum

TypesUserApiEventTypes
stateid

The state (status) id. details in the TypesStateTypes enum Deprecated - please use the is_active flag

TypesStateTypes
parameters

The event parameters to send to the url. detaits in the ParametersDetailsItem enum

Collection of ParametersDetailsItem
is_active

Is this web-hook active or not

boolean
target_type_id

The target of this web hook

TypesUserApiEventTargetTypes
date_updated_utc

date
date_created_utc

date