Environment schema Model API Reference (Environments)
Reference the Novu environment schema used in API requests and responses. Review fields, data types, and object structure for this resource.
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.
| Prop | Type | Default |
|---|---|---|
slug? | string | - |
parentId? | string | - |
apiKeys? | ApiKeyDto[] | - |
type? | EnvironmentResponseDtoType | null | - |
identifier? | string | - |
organizationId? | string | - |
name? | string | - |
id? | string | - |
List all contexts GET
Retrieve a paginated list of all contexts, optionally filtered by type and key pattern. **type** and **id** are optional fields, if provided, only contexts with the matching type and id will be returned. **search** is an optional field, if provided, only contexts with the matching key pattern will be returned. Checkout all possible parameters in the query section below for more details
Create an environment POST
Creates a new environment within the current organization. Environments allow you to manage different stages of your application development lifecycle. Each environment has its own set of API keys and configurations.