string Ordering

{
  "enum": [
    "ascending",
    "descending"
  ],
  "type": "string",
  "description": "Defines the ordering in a listing of results."
}

object RecoverIn

{
  "type": "object",
  "required": [
    "since"
  ],
  "properties": {
    "since": {
      "type": "string",
      "format": "date-time"
    },
    "until": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    }
  }
}

object RecoverOut

{
  "type": "object",
  "required": [
    "id",
    "status",
    "task"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "task": {
      "$ref": "#/components/schemas/BackgroundTaskType"
    },
    "status": {
      "$ref": "#/components/schemas/BackgroundTaskStatus"
    }
  }
}

object ReplayIn

{
  "type": "object",
  "required": [
    "since"
  ],
  "properties": {
    "since": {
      "type": "string",
      "format": "date-time"
    },
    "until": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    }
  }
}

object ReplayOut

{
  "type": "object",
  "required": [
    "id",
    "status",
    "task"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "task": {
      "$ref": "#/components/schemas/BackgroundTaskType"
    },
    "status": {
      "$ref": "#/components/schemas/BackgroundTaskStatus"
    }
  }
}

array RetrySchedule

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Duration"
  }
}

object RetryScheduleInOut

{
  "type": "object",
  "properties": {
    "retrySchedule": {
      "$ref": "#/components/schemas/RetrySchedule",
      "nullable": true
    }
  }
}

object RotatedUrlOut

{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string"
    }
  }
}

object SettingsIn

{
  "type": "object",
  "properties": {
    "readOnly": {
      "type": "boolean",
      "default": false
    },
    "customColor": {
      "type": "string",
      "format": "color",
      "nullable": true
    },
    "displayName": {
      "type": "string",
      "nullable": true
    },
    "enforceHttps": {
      "type": "boolean",
      "default": true
    },
    "customLogoUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true,
      "maxLength": 65536,
      "minLength": 1
    },
    "enableChannels": {
      "type": "boolean",
      "default": false
    },
    "showUseSvixPlay": {
      "type": "boolean",
      "default": true
    },
    "colorPaletteDark": {
      "$ref": "#/components/schemas/CustomColorPalette",
      "nullable": true
    },
    "customFontFamily": {
      "type": "string",
      "example": "Open Sans",
      "pattern": "^[a-zA-Z0-9\\-_ ]+$",
      "nullable": true
    },
    "colorPaletteLight": {
      "$ref": "#/components/schemas/CustomColorPalette",
      "nullable": true
    },
    "customBaseFontSize": {
      "type": "integer",
      "format": "int",
      "nullable": true
    },
    "customFontFamilyUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true,
      "maxLength": 65536,
      "minLength": 1
    },
    "customThemeOverride": {
      "$ref": "#/components/schemas/CustomThemeOverride",
      "nullable": true
    },
    "enableTransformations": {
      "type": "boolean",
      "default": false
    },
    "eventCatalogPublished": {
      "type": "boolean",
      "default": false
    },
    "disableEndpointOnFailure": {
      "type": "boolean",
      "default": true
    },
    "enableIntegrationManagement": {
      "type": "boolean",
      "default": false
    }
  }
}

object SettingsOut

{
  "type": "object",
  "properties": {
    "readOnly": {
      "type": "boolean",
      "default": false
    },
    "customColor": {
      "type": "string",
      "format": "color",
      "nullable": true
    },
    "displayName": {
      "type": "string",
      "nullable": true
    },
    "enforceHttps": {
      "type": "boolean",
      "default": true
    },
    "customLogoUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true,
      "maxLength": 65536,
      "minLength": 1
    },
    "enableChannels": {
      "type": "boolean",
      "default": false
    },
    "showUseSvixPlay": {
      "type": "boolean",
      "default": true
    },
    "colorPaletteDark": {
      "$ref": "#/components/schemas/CustomColorPalette",
      "nullable": true
    },
    "customFontFamily": {
      "type": "string",
      "example": "Open Sans",
      "pattern": "^[a-zA-Z0-9\\-_ ]+$",
      "nullable": true
    },
    "colorPaletteLight": {
      "$ref": "#/components/schemas/CustomColorPalette",
      "nullable": true
    },
    "customBaseFontSize": {
      "type": "integer",
      "format": "int",
      "nullable": true
    },
    "customFontFamilyUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true,
      "maxLength": 65536,
      "minLength": 1
    },
    "customThemeOverride": {
      "$ref": "#/components/schemas/CustomThemeOverride",
      "nullable": true
    },
    "enableTransformations": {
      "type": "boolean",
      "default": false
    },
    "eventCatalogPublished": {
      "type": "boolean",
      "default": false
    },
    "disableEndpointOnFailure": {
      "type": "boolean",
      "default": true
    },
    "enableIntegrationManagement": {
      "type": "boolean",
      "default": false
    }
  }
}

integer StatusCodeClass

{
  "enum": [
    0,
    100,
    200,
    300,
    400,
    500
  ],
  "type": "integer",
  "title": "StatusCodeClass",
  "description": "The different classes of HTTP status codes:\n- CodeNone = 0\n- Code1xx = 100\n- Code2xx = 200\n- Code3xx = 300\n- Code4xx = 400\n- Code5xx = 500",
  "x-enum-varnames": [
    "CodeNone",
    "Code1xx",
    "Code2xx",
    "Code3xx",
    "Code4xx",
    "Code5xx"
  ]
}

object TemplateIn

{
  "type": "object",
  "required": [
    "logo",
    "name",
    "transformation"
  ],
  "properties": {
    "kind": {
      "$ref": "#/components/schemas/TransformationTemplateKind",
      "default": "Custom"
    },
    "logo": {
      "type": "string",
      "format": "uri"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string",
      "default": ""
    },
    "featureFlag": {
      "type": "string",
      "example": "cool-new-feature",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256
    },
    "filterTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "user.signup",
        "pattern": "^[a-zA-Z0-9\\-_.]+$",
        "maxLength": 256,
        "description": "The event type's name"
      },
      "example": [
        "user.signup",
        "user.deleted"
      ],
      "minItems": 1,
      "nullable": true,
      "uniqueItems": true
    },
    "instructions": {
      "type": "string",
      "default": ""
    },
    "transformation": {
      "type": "string",
      "maxLength": 51200,
      "minLength": 10
    },
    "instructionsLink": {
      "type": "string",
      "format": "uri",
      "default": null,
      "nullable": true
    }
  }
}

object TemplateOut

{
  "type": "object",
  "required": [
    "createdAt",
    "description",
    "id",
    "instructions",
    "kind",
    "logo",
    "name",
    "orgId",
    "transformation",
    "updatedAt"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "kind": {
      "$ref": "#/components/schemas/TransformationTemplateKind"
    },
    "logo": {
      "type": "string",
      "format": "uri"
    },
    "name": {
      "type": "string"
    },
    "orgId": {
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "description": {
      "type": "string"
    },
    "featureFlag": {
      "type": "string",
      "example": "cool-new-feature",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256
    },
    "filterTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "user.signup",
        "pattern": "^[a-zA-Z0-9\\-_.]+$",
        "maxLength": 256,
        "description": "The event type's name"
      },
      "example": [
        "user.signup",
        "user.deleted"
      ],
      "minItems": 1,
      "nullable": true,
      "uniqueItems": true
    },
    "instructions": {
      "type": "string"
    },
    "transformation": {
      "type": "string"
    },
    "instructionsLink": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  }
}

object TemplatePatch

{
  "type": "object",
  "properties": {
    "kind": {
      "$ref": "#/components/schemas/TransformationTemplateKind"
    },
    "logo": {
      "type": "string",
      "format": "uri"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "featureFlag": {
      "type": "string",
      "example": "cool-new-feature",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256
    },
    "filterTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "user.signup",
        "pattern": "^[a-zA-Z0-9\\-_.]+$",
        "maxLength": 256,
        "description": "The event type's name"
      },
      "example": [
        "user.signup",
        "user.deleted"
      ],
      "minItems": 1,
      "nullable": true,
      "uniqueItems": true
    },
    "instructions": {
      "type": "string"
    },
    "transformation": {
      "type": "string",
      "maxLength": 51200,
      "minLength": 10
    },
    "instructionsLink": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  }
}

object TemplateUpdate

{
  "type": "object",
  "required": [
    "logo",
    "transformation"
  ],
  "properties": {
    "kind": {
      "$ref": "#/components/schemas/TransformationTemplateKind",
      "default": "Custom"
    },
    "logo": {
      "type": "string",
      "format": "uri"
    },
    "name": {
      "type": "string",
      "default": ""
    },
    "description": {
      "type": "string",
      "default": ""
    },
    "featureFlag": {
      "type": "string",
      "example": "cool-new-feature",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256
    },
    "filterTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "user.signup",
        "pattern": "^[a-zA-Z0-9\\-_.]+$",
        "maxLength": 256,
        "description": "The event type's name"
      },
      "example": [
        "user.signup",
        "user.deleted"
      ],
      "minItems": 1,
      "nullable": true,
      "uniqueItems": true
    },
    "instructions": {
      "type": "string",
      "default": ""
    },
    "transformation": {
      "type": "string",
      "maxLength": 51200,
      "minLength": 10
    },
    "instructionsLink": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  }
}

string TransformationHttpMethod

{
  "enum": [
    "POST",
    "PUT"
  ],
  "type": "string"
}

object TransformationSimulateIn

{
  "type": "object",
  "required": [
    "code",
    "eventType",
    "payload"
  ],
  "properties": {
    "code": {
      "type": "string",
      "maxLength": 51200,
      "minLength": 10
    },
    "payload": {
      "type": "object"
    },
    "channels": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "project_1337",
        "pattern": "^[a-zA-Z0-9\\-_.]+$",
        "maxLength": 128
      },
      "nullable": true,
      "uniqueItems": true
    },
    "eventType": {
      "type": "string",
      "example": "user.signup",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "maxLength": 256,
      "description": "The event type's name"
    }
  }
}

object TransformationSimulateOut

{
  "type": "object",
  "required": [
    "payload",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "maxLength": 65536,
      "minLength": 1
    },
    "method": {
      "$ref": "#/components/schemas/TransformationHttpMethod",
      "nullable": true
    },
    "payload": {
      "type": "string"
    }
  }
}

string TransformationTemplateKind

{
  "enum": [
    "Custom",
    "CustomerIO",
    "Discord",
    "Hubspot",
    "Inngest",
    "Salesforce",
    "Segment",
    "Slack",
    "Teams",
    "TriggerDev",
    "Windmill",
    "Zapier"
  ],
  "type": "string"
}

object ValidationError

{
  "type": "object",
  "required": [
    "loc",
    "msg",
    "type"
  ],
  "properties": {
    "loc": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The location as a [`Vec`] of [`String`]s -- often in the form `[\"body\", \"field_name\"]`, `[\"query\", \"field_name\"]`, etc. They may, however, be arbitrarily deep."
    },
    "msg": {
      "type": "string",
      "description": "The message accompanying the validation error item."
    },
    "type": {
      "type": "string",
      "description": "The type of error, often \"type_error\" or \"value_error\", but sometimes with more context like as \"value_error.number.not_ge\""
    }
  },
  "description": "Validation errors have their own schema to provide context for invalid requests eg. mismatched types and out of bounds values. There may be any number of these per 422 UNPROCESSABLE ENTITY error."
}