Skip to content

Create Watch

POST
/api/watches
curl --request POST \
--url http://localhost:8000/api/watches \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "config": {}, "create_webhook_rule": false, "interval": "example", "kind": "example", "lead_id": 1, "signal_types": [ "example" ], "target": "example", "webhook_secret_ref": "example", "webhook_url": "example" }'
x-workspace-id
Any of:
string
Media typeapplication/json
WatchCreate
object
config
Any of:
object
key
additional properties
any
create_webhook_rule
Create Webhook Rule
boolean
interval
Any of:
string
kind
required
Kind
string
lead_id
Any of:
integer
signal_types
Any of:
Array<string>
target
required
Target
string
>= 1 characters
webhook_secret_ref
Any of:
string
webhook_url
Any of:
string

Successful Response

Media typeapplication/json
Examplegenerated
example

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}