Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Content-Type
string
required

Path Parameters

hookId
string
required

Body

application/json
metadata
object
functionId
string
Pattern: ^((cradl|las):organization:[a-z0-9-_]+/)?cradl:function:[a-z0-9-_]+$
falseActionId
string
Pattern: ^((cradl|las):organization:[a-z0-9-_]+/)?cradl:action:[a-z0-9-_]+$
trueActionId
string
Pattern: ^((cradl|las):organization:[a-z0-9-_]+/)?cradl:action:[a-z0-9-_]+$
name
string | null
Maximum string length: 4096
description
string | null
Maximum string length: 4096
trigger
enum<string>
Available options:
ActionRun has Completed,
Document is Created,
Email is Received,
Prediction is Created,
ValidationTask has Completed,
ValidationTask is Created
config
object
enabled
boolean

Response

200 response

updatedTime
string | null
required
Pattern: ^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$
metadata
object | null
required
updatedBy
string | null
required
Maximum string length: 4096
description
string | null
required
Maximum string length: 4096
createdBy
string
required
Maximum string length: 4096
hookId
string
required
Pattern: ^cradl:hook:[a-f0-9]{32}$
name
string | null
required
Maximum string length: 4096
createdTime
string
required
Pattern: ^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$
trigger
enum<string>
Available options:
ActionRun has Completed,
Document is Created,
Email is Received,
Prediction is Created,
ValidationTask has Completed,
ValidationTask is Created
enabled
boolean
functionId
string | null
Pattern: ^((cradl|las):organization:[a-z0-9-_]+/)?cradl:function:[a-z0-9-_]+$
falseActionId
string | null
Pattern: ^((cradl|las):organization:[a-z0-9-_]+/)?cradl:action:[a-z0-9-_]+$
trueActionId
string | null
Pattern: ^((cradl|las):organization:[a-z0-9-_]+/)?cradl:action:[a-z0-9-_]+$
id
string
Pattern: ^((cradl|las):organization:[a-z0-9-_]+/)?cradl:hook:[a-z0-9-_]+$
config
object | null