Skip to main content
GET
List tenant settings (optionally assembled as webhook config)

Description

Pass ?include=webhook or ?assembleWebhook=true to additionally receive an assembled webhook object combining the webhook-config.* settings with read-only delivery metrics. Authorization:
  • Any authenticated tenant user

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

include
enum<string>

Set to webhook to include the assembled webhook config + metrics

Available options:
webhook
assembleWebhook
enum<string>

Alternative to include=webhook; set to true to include the assembled webhook config + metrics

Available options:
true

Response

Tenant settings retrieved successfully

success
boolean
Example:

true

data
object[]
webhook
object

Returned only when requested via ?include=webhook/?assembleWebhook=true, or after a PUT to a webhook-config.* setting