Skip to main content

PartnerWithWebhooksResponseDto

Response representing a partner along with its partner-level and tenant-level webhooks.

namestringrequired

The name of the partner

Example: Kaunt
idstringrequired

UUID of the partner

Example: 92f74e96-a654-47e2-84c8-7a8843cda443
partnerWebhooks object[]required

List of webhooks associated with the partner

  • Array [
    • urlstringrequired

    URL of the webhook

    Example: https://foo.com/webhooks/bar
    descriptionstringnullable

    Description of the webhook

    Example: Webhook for X production
    idstring<uuid>required

    UUID of the webhook

    Example: 92f74e96-a654-47e2-84c8-7a8843cda443
    apiEnvironmentAPIEnvironment (string)required

    Possible values: [Sandbox, Production]

    signingSecretKeystringrequired

    Signature key secret

    Example: 92f74e96a65447e284c87a8843cda443
  • ]
    • tenantWebhooks object[]required

    List of tenants with their associated webhooks

  • Array [
    • namestringrequired

    Name of the tenant

    Example: KauntTenant
    idstringrequired

    UUID of the tenant

    Example: 75de5c95-4a0c-4fee-8811-434a9ecd7e79
    regionKauntRegionEnum (string)required

    Possible values: [EU1_FRANCE, US1_ARIZONA]

    markedForDeletionboolean

    Indicates whether the tenant is marked for deletion. This property is used to track tenants that are scheduled for removal from the system. When set to true, it signifies that the tenant is in the process of being deleted and should not be used for any further operations.

    Example: false
    disabledModelsstring[]

    List of disabled models for the tenant.

    webhooks object[]required

    The collection of webhooks associated with the tenant.

  • Array [
    • urlstringrequired

    URL of the webhook

    Example: https://foo.com/webhooks/bar
    descriptionstringnullable

    Description of the webhook

    Example: Webhook for X production
    idstring<uuid>required

    UUID of the webhook

    Example: 92f74e96-a654-47e2-84c8-7a8843cda443
    apiEnvironmentAPIEnvironment (string)required

    Possible values: [Sandbox, Production]

    signingSecretKeystringrequired

    Signature key secret

    Example: 92f74e96a65447e284c87a8843cda443
  • ]
  • ]
    • PartnerWithWebhooksResponseDto
    {
      "name": "Kaunt",
      "id": "92f74e96-a654-47e2-84c8-7a8843cda443",
      "partnerWebhooks": [
        {
          "url": "https://foo.com/webhooks/bar",
          "description": "Webhook for X production",
          "id": "92f74e96-a654-47e2-84c8-7a8843cda443",
          "apiEnvironment": "Sandbox",
          "signingSecretKey": "92f74e96a65447e284c87a8843cda443"
        }
      ],
      "tenantWebhooks": [
        {
          "name": "KauntTenant",
          "id": "75de5c95-4a0c-4fee-8811-434a9ecd7e79",
          "region": "EU1_FRANCE",
          "markedForDeletion": false,
          "disabledModels": [
            "string"
          ],
          "webhooks": [
            {
              "url": "https://foo.com/webhooks/bar",
              "description": "Webhook for X production",
              "id": "92f74e96-a654-47e2-84c8-7a8843cda443",
              "apiEnvironment": "Sandbox",
              "signingSecretKey": "92f74e96a65447e284c87a8843cda443"
            }
          ]
        }
      ]
    }