Skip to main content
POST
/
v2
/
environments
/
{targetEnvironmentId}
/
publish
PHP
declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;

$sdk = novu\Novu::builder()
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();

$publishEnvironmentRequestDto = new Components\PublishEnvironmentRequestDto(
    sourceEnvironmentId: '507f1f77bcf86cd799439011',
    resources: [
        new Components\ResourceToPublishDto(
            resourceType: Components\ResourceTypeEnum::Regular,
            resourceId: 'workflow-id-1',
        ),
    ],
);

$response = $sdk->environments->publish(
    targetEnvironmentId: '6615943e7ace93b0540ae377',
    publishEnvironmentRequestDto: $publishEnvironmentRequestDto

);

if ($response->publishEnvironmentResponseDto !== null) {
    // handle response
}
{
  "results": [
    {
      "successful": [
        {
          "resourceId": "<string>",
          "resourceName": "<string>"
        }
      ],
      "failed": [
        {
          "resourceId": "<string>",
          "resourceName": "<string>",
          "error": "<string>",
          "stack": "<string>"
        }
      ],
      "skipped": [
        {
          "resourceId": "<string>",
          "resourceName": "<string>",
          "reason": "<string>"
        }
      ],
      "totalProcessed": 123
    }
  ],
  "summary": {
    "resources": 123,
    "successful": 123,
    "failed": 123,
    "skipped": 123
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".

Headers

idempotency-key
string

A header for idempotency purposes

Path Parameters

targetEnvironmentId
string
required

Target environment ID (MongoDB ObjectId) to publish resources to

Body

application/json

Publish request configuration

sourceEnvironmentId
string

Source environment ID to sync from. Defaults to the Development environment if not provided.

Example:

"507f1f77bcf86cd799439011"

dryRun
boolean
default:false

Perform a dry run without making actual changes

resources
object[]

Array of specific resources to publish. If not provided, all resources will be published.

Response

OK

results
object[]
required

Sync results by resource type

summary
object
required

Summary of the sync operation