Skip to main content
PATCH
/
hooks
/
{hookId}
cURL
curl --request PATCH \
  --url https://api.lucidtech.ai/{basePath}/hooks/{hookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "metadata": {},
  "functionId": "<string>",
  "falseActionId": "<string>",
  "trueActionId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "trigger": "ActionRun has Completed",
  "config": {},
  "enabled": true
}
'
{
  "updatedTime": "<string>",
  "metadata": {},
  "updatedBy": "<string>",
  "description": "<string>",
  "createdBy": "<string>",
  "hookId": "<string>",
  "name": "<string>",
  "createdTime": "<string>",
  "trigger": "ActionRun has Completed",
  "enabled": true,
  "functionId": "<string>",
  "falseActionId": "<string>",
  "trueActionId": "<string>",
  "id": "<string>",
  "config": {}
}

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
falseActionId
string
trueActionId
string
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
metadata
object
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
name
string | null
required
Maximum string length: 4096
createdTime
string
required
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
falseActionId
string | null
trueActionId
string | null
id
string
config
object