NOnovu
Environments

Compare resources between environments

Changed on

Compares workflows and other resources between the development and target environments, returning detailed diff information including additions, modifications, and deletions.

post/v2/environments/{targetEnvironmentId}/diff

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 compare against

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.

Example request

{
  "sourceEnvironmentId": "507f1f77bcf86cd799439011"
}

Response

OK

sourceEnvironmentIdstring required

Source environment ID

targetEnvironmentIdstring required

Target environment ID

Example response

{
  "resources": [
    {
      "sourceResource": {
        "updatedAt": "2024-01-15T10:30:00.000Z"
      },
      "targetResource": {
        "updatedAt": "2024-01-15T10:30:00.000Z"
      },
      "changes": [
        {
          "sourceResource": {
            "updatedAt": "2024-01-15T10:30:00.000Z"
          },
          "targetResource": {
            "updatedAt": "2024-01-15T10:30:00.000Z"
          }
        }
      ]
    }
  ]
}

Changes

  • a5b639d63138Revision changes
    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the ///////// response's property type changed from no type to object for status

    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the ///////// response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from no type to object for status

    • breaking

      the /////// response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from no type to object for status

    • breaking

      the /////// response's property type changed from no type to object for status

  • ca78ba235703Revision changes
    • warning

      added the new AGENT_EXISTS_IN_TARGET enum value to the //// response property for the response status

    • warning

      added the new AGENT_REQUIRED_FOR_WORKFLOW enum value to the //// response property for the response status