Skip to content

List all webhooks

GET
/v1/webhooks
curl --request GET \
--url http://api.disclosebot.localdev:3000/v1/webhooks \
--header 'Authorization: Bearer <token>'
page[number]
integer
page[size]
integer

Successful

Media type application/vnd.api+json
object
data
required
Array<object>
object
id
required
string format: uuid
type
required
string
Allowed values: webhook
attributes
required
object
name
required
string
short_description
string
nullable
url
required
string format: uri
enabled
required
boolean
created_at
required
string format: date-time
updated_at
required
string format: date-time
relationships
object
trigger_event_types
object
data
Array<object>
object
id
required
string format: uuid
type
required
string
Allowed values: trigger_event_type
organization
object
data
object
id
required
string format: uuid
type
required
string
Allowed values: organization
tunnel_endpoint
object
data
object
id
string format: uuid
type
string
Allowed values: tunnel_endpoint
local_app
object
data
object
id
string format: uuid
type
string
Allowed values: local_app
Example
{
"data": [
{
"type": "webhook",
"relationships": {
"trigger_event_types": {
"data": [
{
"type": "trigger_event_type"
}
]
},
"organization": {
"data": {
"type": "organization"
}
},
"tunnel_endpoint": {
"data": {
"type": "tunnel_endpoint"
}
},
"local_app": {
"data": {
"type": "local_app"
}
}
}
}
]
}

Unauthorized