Novu · Schema

EnvironmentResponseDto

JSON Schema for Novu EnvironmentResponseDto.

NotificationsMessagingIn AppEmailSMSPushChatWorkflowsOpen SourceSubscribersTopicsInboxWorkflow OrchestrationMulti ChannelDigestMCPFrameworkReact

Properties

Name	Type	Description
_id	string	Unique identifier of the environment
name	string	Name of the environment
_organizationId	string	Organization ID associated with the environment
identifier	string	Unique identifier for the environment
type	stringnull	Type of the environment
apiKeys	array	List of API keys associated with the environment
_parentId	string	Parent environment ID
slug	string	URL-friendly slug for the environment

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/novu/main/json-schema/novu-environment-response-dto-schema.json",
  "title": "EnvironmentResponseDto",
  "description": "JSON Schema for Novu EnvironmentResponseDto.",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "Unique identifier of the environment",
      "example": "60d5ecb8b3b3a30015f3e1a1"
    },
    "name": {
      "type": "string",
      "description": "Name of the environment",
      "example": "Production Environment"
    },
    "_organizationId": {
      "type": "string",
      "description": "Organization ID associated with the environment",
      "example": "60d5ecb8b3b3a30015f3e1a2"
    },
    "identifier": {
      "type": "string",
      "description": "Unique identifier for the environment",
      "example": "prod-env-01"
    },
    "type": {
      "enum": [
        "dev",
        "prod"
      ],
      "type": [
        "string",
        "null"
      ],
      "description": "Type of the environment",
      "example": "prod"
    },
    "apiKeys": {
      "description": "List of API keys associated with the environment",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "API key",
            "example": "sk_test_1234567890abcdef"
          },
          "_userId": {
            "type": "string",
            "description": "User ID associated with the API key",
            "example": "60d5ecb8b3b3a30015f3e1a4"
          },
          "hash": {
            "type": "string",
            "description": "Hashed representation of the API key",
            "example": "hash_value_here"
          }
        },
        "required": [
          "key",
          "_userId"
        ]
      }
    },
    "_parentId": {
      "type": "string",
      "description": "Parent environment ID",
      "example": "60d5ecb8b3b3a30015f3e1a3"
    },
    "slug": {
      "type": "string",
      "description": "URL-friendly slug for the environment",
      "example": "production"
    }
  },
  "required": [
    "_id",
    "name",
    "_organizationId",
    "identifier"
  ]
}