Skip to content

Create Subscription

POST
/webhooks
curl --request POST \
--url https://example.com/webhooks \
--header 'Content-Type: application/json' \
--data '{ "event_types": [ "*" ], "secret": "example", "url": "example" }'
Media typeapplication/json
SubscriptionCreate
object
event_types
Event Types
Array<string>
default: *
secret
Any of:
string
url
required
Url
string

Successful Response

Media typeapplication/json
SubscriptionOut
object
active
required
Active
boolean
event_types
required
Event Types
Array<string>
has_secret
required
Has Secret
boolean
id
required
Id
string format: uuid
url
required
Url
string

Example generated

{
"active": true,
"event_types": [
"example"
],
"has_secret": true,
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"url": "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

Example generated

{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}