Back to Novu

Environment schema

docs/api-reference/environments/environment-schema.mdx

3.18.01.1 KB
Original Source

Environment

Environment is a collection of resources that are used to send notifications. For example, an environment can have a set of integrations, workflows, and subscribers. Read more about environments on environments concept page.

<ResponseField name="id" type="string"> Unique identifier of the environment </ResponseField> <ResponseField name="name" type="string"> Name of the environment </ResponseField> <ResponseField name="organizationId" type="string"> Organization ID associated with the environment </ResponseField> <ResponseField name="identifier" type="string"> Unique identifier for the environment </ResponseField> <ResponseField name="type" type="EnvironmentResponseDtoType"> Type of the environment </ResponseField> <ResponseField name="apiKeys" type="ApiKeyDto[]"> List of API keys associated with the environment </ResponseField> <ResponseField name="parentId" type="string"> Parent environment ID </ResponseField> <ResponseField name="slug" type="string"> URL-friendly slug for the environment </ResponseField>