API Reference

Webhooks

Subscriptions, deliveries and the event catalogue.

16 endpoints· Auth: JWT
get/api/v1/console/developers/webhook-deliveries JWT

Get webhook-deliveries

Query parameters

SubscriptionId
string (uuid)
—
Status
string
—
EventType
string
—
ResourceType
string
—
From
string (date-time)
—
To
string (date-time)
—
Page
integer (int32)
—
PerPage
integer (int32)
—
Search
string
—
Skip
integer (int32)
—
Sort
string
—
Dir
string
—

Responses

200Success
cURL
curl -X GET "https://staging-api.panoptesos.com/api/v1/console/developers/webhook-deliveries" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com

Query parameters

Set credentials in the “Authorize” menu
get/api/v1/console/developers/webhook-deliveries/{id} JWT

Get id

Path parameters

idrequired
string (uuid)
—

Responses

200Success
cURL
curl -X GET "https://staging-api.panoptesos.com/api/v1/console/developers/webhook-deliveries/{id}" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Set credentials in the “Authorize” menu
post/api/v1/console/developers/webhook-deliveries/{id}/retry JWT

Create retry

Path parameters

idrequired
string (uuid)
—

Request body

application/json
{
  "reason": "string"
}
reason
string
—

Responses

200Success
cURL
curl -X POST "https://staging-api.panoptesos.com/api/v1/console/developers/webhook-deliveries/{id}/retry" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -d '{
  "reason": "string"
}'
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Request body (JSON)

Set credentials in the “Authorize” menu
post/api/v1/console/developers/webhook-deliveries/retry-failed JWT

Create retry-failed

Request body

application/json
{
  "subscriptionId": "00000000-0000-0000-0000-000000000000"
}
subscriptionId
string (uuid)
—

Responses

200Success
cURL
curl -X POST "https://staging-api.panoptesos.com/api/v1/console/developers/webhook-deliveries/retry-failed" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -d '{
  "subscriptionId": "00000000-0000-0000-0000-000000000000"
}'
Try itagainst staging · https://staging-api.panoptesos.com

Request body (JSON)

Set credentials in the “Authorize” menu
get/api/v1/console/developers/webhooks JWT

Get webhooks

Query parameters

IncludeInactive
boolean
—
EventType
string
—
Page
integer (int32)
—
PerPage
integer (int32)
—
Search
string
—
Skip
integer (int32)
—
Sort
string
—
Dir
string
—

Responses

200Success
cURL
curl -X GET "https://staging-api.panoptesos.com/api/v1/console/developers/webhooks" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com

Query parameters

Set credentials in the “Authorize” menu
post/api/v1/console/developers/webhooks JWT

Create webhooks

Request body

application/json
{
  "url": "string",
  "events": [
    "string"
  ],
  "apiVersion": "string"
}
url
string
—
events
string[]
—
apiVersion
string
—

Responses

200Success
cURL
curl -X POST "https://staging-api.panoptesos.com/api/v1/console/developers/webhooks" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -d '{
  "url": "string",
  "events": [
    "string"
  ],
  "apiVersion": "string"
}'
Try itagainst staging · https://staging-api.panoptesos.com

Request body (JSON)

Set credentials in the “Authorize” menu
get/api/v1/console/developers/webhooks/{id} JWT

Get id

Path parameters

idrequired
string (uuid)
—

Responses

200Success
cURL
curl -X GET "https://staging-api.panoptesos.com/api/v1/console/developers/webhooks/{id}" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Set credentials in the “Authorize” menu
put/api/v1/console/developers/webhooks/{id} JWT

Update id

Path parameters

idrequired
string (uuid)
—

Request body

application/json
{
  "url": "string",
  "events": [
    "string"
  ],
  "apiVersion": "string",
  "active": false
}
url
string
—
events
string[]
—
apiVersion
string
—
active
boolean
—

Responses

200Success
cURL
curl -X PUT "https://staging-api.panoptesos.com/api/v1/console/developers/webhooks/{id}" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -d '{
  "url": "string",
  "events": [
    "string"
  ],
  "apiVersion": "string",
  "active": false
}'
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Request body (JSON)

Set credentials in the “Authorize” menu
delete/api/v1/console/developers/webhooks/{id} JWT

Delete id

Path parameters

idrequired
string (uuid)
—

Request body

application/json
{
  "reason": "string"
}
reason
string
—

Responses

200Success
cURL
curl -X DELETE "https://staging-api.panoptesos.com/api/v1/console/developers/webhooks/{id}" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Set credentials in the “Authorize” menu
post/api/v1/console/developers/webhooks/{id}/activate JWT

Create activate

Path parameters

idrequired
string (uuid)
—

Responses

200Success
cURL
curl -X POST "https://staging-api.panoptesos.com/api/v1/console/developers/webhooks/{id}/activate" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Set credentials in the “Authorize” menu
post/api/v1/console/developers/webhooks/{id}/deactivate JWT

Create deactivate

Path parameters

idrequired
string (uuid)
—

Request body

application/json
{
  "reason": "string"
}
reason
string
—

Responses

200Success
cURL
curl -X POST "https://staging-api.panoptesos.com/api/v1/console/developers/webhooks/{id}/deactivate" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -d '{
  "reason": "string"
}'
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Request body (JSON)

Set credentials in the “Authorize” menu
get/api/v1/console/developers/webhooks/{id}/deliveries JWT

Get deliveries

Path parameters

idrequired
string (uuid)
—

Query parameters

SubscriptionId
string (uuid)
—
Status
string
—
EventType
string
—
ResourceType
string
—
From
string (date-time)
—
To
string (date-time)
—
Page
integer (int32)
—
PerPage
integer (int32)
—
Search
string
—
Skip
integer (int32)
—
Sort
string
—
Dir
string
—

Responses

200Success
cURL
curl -X GET "https://staging-api.panoptesos.com/api/v1/console/developers/webhooks/{id}/deliveries" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Query parameters

Set credentials in the “Authorize” menu
post/api/v1/console/developers/webhooks/{id}/rotate-secret JWT

Create rotate-secret

Path parameters

idrequired
string (uuid)
—

Responses

200Success
cURL
curl -X POST "https://staging-api.panoptesos.com/api/v1/console/developers/webhooks/{id}/rotate-secret" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Set credentials in the “Authorize” menu
post/api/v1/console/developers/webhooks/{id}/test JWT

Create test

Path parameters

idrequired
string (uuid)
—

Request body

application/json
{
  "reason": "string"
}
reason
string
—

Responses

200Success
cURL
curl -X POST "https://staging-api.panoptesos.com/api/v1/console/developers/webhooks/{id}/test" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -d '{
  "reason": "string"
}'
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Request body (JSON)

Set credentials in the “Authorize” menu
get/api/v1/console/developers/webhooks/event-catalog JWT

Get event-catalog

Responses

200Success
cURL
curl -X GET "https://staging-api.panoptesos.com/api/v1/console/developers/webhooks/event-catalog" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com
Set credentials in the “Authorize” menu
get/api/v1/console/developers/webhooks/event-types JWT

Get event-types

Responses

200Success
cURL
curl -X GET "https://staging-api.panoptesos.com/api/v1/console/developers/webhooks/event-types" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com
Set credentials in the “Authorize” menu