Environments

Publish resources to target environment

Publishes all workflows and resources from the development environment to the target environment. Optionally specify specific resources to publish or use dryRun mode to preview changes.

post/v2/environments/{targetEnvironmentId}/publish

Request

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

Path parameters

targetEnvironmentIdstring required
Example:6615943e7ace93b0540ae377

Target environment ID (MongoDB ObjectId) to publish resources to

Headers

idempotency-keystring

A header for idempotency purposes

Request body

sourceEnvironmentIdstring

Source environment ID. Only the Development environment is currently supported; defaults to Development if omitted.

dryRunboolean

Perform a dry run without making actual changes

Example request

{
  "sourceEnvironmentId": "507f1f77bcf86cd799439011",
  "resources": [
    {
      "resourceId": "workflow-id-1"
    }
  ]
}

Response

OK

Changes

No recorded changes to this operation across all 20 revisions of this API.