README

The <Inbox /> infrastructure for modern products

The notification platform that turns complex multi-channel delivery into a single component. Built for developers, designed for growth, powered by open source.

Novu PHP SDK

The PHP Novu SDK and package provides a fluent and expressive interface for interacting with Novu's API and managing notifications.

Developer-friendly & type-safe Php SDK specifically catered to leverage novuhq/novu API.

Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Novu API: Novu REST API. Please see https://docs.novu.co/api-reference for more details.

For more information about the API: Novu Documentation

Table of Contents

• Novu PHP SDK
  • SDK Installation
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK relies on Composer to manage its dependencies.

To install the SDK and add it as a dependency to an existing composer.json file:

composer require "novuhq/novu"

SDK Example Usage

Trigger Notification Event

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;

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

$triggerEventRequestDto = new Components\TriggerEventRequestDto(
    workflowId: 'workflow_identifier',
    payload: [
        'comment_id' => 'string',
        'post' => [
            'text' => 'string',
        ],
    ],
    overrides: new Components\Overrides(),
    to: 'SUBSCRIBER_ID',
    actor: '<value>',
    context: [
        'key' => 'org-acme',
    ],
);

$response = $sdk->trigger(
    triggerEventRequestDto: $triggerEventRequestDto
);

if ($response->triggerEventResponseDto !== null) {
    // handle response
}

Cancel Triggered Event

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;

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



$response = $sdk->cancel(
    transactionId: '<id>'
);

if ($response->boolean !== null) {
    // handle response
}

Broadcast Event to All

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;

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

$triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
    name: '<value>',
    payload: [
        'comment_id' => 'string',
        'post' => [
            'text' => 'string',
        ],
    ],
    overrides: new Components\TriggerEventToAllRequestDtoOverrides(
        additionalProperties: [
            'fcm' => [
                'data' => [
                    'key' => 'value',
                ],
            ],
        ],
    ),
    actor: new Components\SubscriberPayloadDto(
        firstName: 'John',
        lastName: 'Doe',
        email: 'john.doe@example.com',
        phone: '+1234567890',
        avatar: 'https://example.com/avatar.jpg',
        locale: 'en-US',
        timezone: 'America/New_York',
        subscriberId: '<id>',
    ),
    context: [
        'key' => 'org-acme',
    ],
);

$response = $sdk->triggerBroadcast(
    triggerEventToAllRequestDto: $triggerEventToAllRequestDto
);

if ($response->triggerEventResponseDto !== null) {
    // handle response
}

Trigger Notification Events in Bulk

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;

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

$bulkTriggerEventDto = new Components\BulkTriggerEventDto(
    events: [
        new Components\TriggerEventRequestDto(
            workflowId: 'workflow_identifier',
            payload: [
                'comment_id' => 'string',
                'post' => [
                    'text' => 'string',
                ],
            ],
            overrides: new Components\Overrides(),
            to: 'SUBSCRIBER_ID',
        ),
        new Components\TriggerEventRequestDto(
            workflowId: 'workflow_identifier',
            payload: [
                'comment_id' => 'string',
                'post' => [
                    'text' => 'string',
                ],
            ],
            overrides: new Components\Overrides(),
            to: 'SUBSCRIBER_ID',
        ),
        new Components\TriggerEventRequestDto(
            workflowId: 'workflow_identifier',
            payload: [
                'comment_id' => 'string',
                'post' => [
                    'text' => 'string',
                ],
            ],
            overrides: new Components\Overrides(),
            to: 'SUBSCRIBER_ID',
        ),
    ],
);

$response = $sdk->triggerBulk(
    bulkTriggerEventDto: $bulkTriggerEventDto
);

if ($response->triggerEventResponseDtos !== null) {
    // handle response
}

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
secretKey	apiKey	API key

To authenticate with the API the secretKey parameter must be set when initializing the SDK. For example:

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;

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

$triggerEventRequestDto = new Components\TriggerEventRequestDto(
    workflowId: 'workflow_identifier',
    payload: [
        'comment_id' => 'string',
        'post' => [
            'text' => 'string',
        ],
    ],
    overrides: new Components\Overrides(),
    to: 'SUBSCRIBER_ID',
    actor: '<value>',
    context: [
        'key' => 'org-acme',
    ],
);

$response = $sdk->trigger(
    triggerEventRequestDto: $triggerEventRequestDto
);

if ($response->triggerEventResponseDto !== null) {
    // handle response
}

Available Resources and Operations

Available methods

Novu SDK

• trigger - Trigger event
• cancel - Cancel triggered event
• triggerBroadcast - Broadcast event to all
• triggerBulk - Bulk trigger event

Activity

• track - Track provider activity and engagement events

ChannelConnections

• list - List all channel connections
• create - Create a channel connection
• retrieve - Retrieve a channel connection
• update - Update a channel connection
• delete - Delete a channel connection

ChannelEndpoints

• list - List all channel endpoints
• create - Create a channel endpoint
• retrieve - Retrieve a channel endpoint
• update - Update a channel endpoint
• delete - Delete a channel endpoint

Contexts

• create - Create a context
• list - List all contexts
• update - Update a context
• retrieve - Retrieve a context
• delete - Delete a context

Domains

• list - List domains for an environment
• create - Create a domain
• retrieve - Retrieve a domain by name
• update - Update a domain
• delete - Delete a domain
• diagnose - Diagnose inbound DNS for a domain
• verify - Verify a domain

Domains.AutoConfigure

• retrieve - Retrieve auto-configuration availability
• start - Start DNS auto-configuration

Domains.Routes

• list - List routes for a domain
• create - Create a route
• retrieve - Retrieve a route by address
• update - Update a route
• delete - Delete a route
• test - Test an inbound route

EnvironmentVariables

• list - List all variables
• create - Create a variable
• retrieve - Get environment variable
• update - Update a variable
• delete - Delete environment variable
• usage - Retrieve a variable usage

Environments

• getTags - List environment tags
• diff - Compare resources between environments
• publish - Publish resources to target environment
• create - Create an environment
• list - List all environments
• update - Update an environment
• delete - Delete an environment

Integrations

• list - List all integrations
• create - Create an integration
• update - Update an integration
• delete - Delete an integration
• integrationsControllerAutoConfigureIntegration - Auto-configure an integration for inbound webhooks
• setAsPrimary - Update integration as primary
• createMobileLink - Issue a short-lived mobile setup link for an existing integration
• integrationsControllerConfigureIntegrationWebhook - Configure a chat integration webhook
• listActive - List active integrations
• generateConnectOAuthUrl - Generate OAuth URL for a workspace/tenant connection
• linkChannelEndpoint - Issue a URL to link a subscriber chat identity
• generateLinkUserOAuthUrl - Generate OAuth URL to link a subscriber user identity
• generateChatOAuthUrl - Generate chat OAuth URL ⚠️ Deprecated

Layouts

• create - Create a layout
• list - List all layouts
• update - Update a layout
• retrieve - Retrieve a layout
• delete - Delete a layout
• duplicate - Duplicate a layout
• generatePreview - Generate layout preview
• usage - Get layout usage

Messages

• get - List all messages
• delete - Delete a message
• deleteByTransactionId - Delete messages by transactionId

Notifications

• list - List all events
• get - Retrieve an event

Subscribers

• search - Search subscribers
• create - Create a subscriber
• get - Retrieve a subscriber
• patch - Update a subscriber
• delete - Delete a subscriber
• createBulk - Bulk create subscribers
• updatePreferences - Update subscriber preferences
• updateCredentials - Update provider credentials
• updateOnlineStatus - Update subscriber online status

Subscribers.Notifications

• list - Retrieve subscriber notifications
• delete - Delete a notification
• completeAction - Complete a notification action
• revertAction - Revert a notification action
• archive - Archive a notification
• markAsRead - Mark a notification as read
• snooze - Snooze a notification
• unarchive - Unarchive a notification
• markAsUnread - Mark a notification as unread
• unsnooze - Unsnooze a notification
• archiveAll - Archive all notifications
• count - Retrieve subscriber notifications count
• deleteAll - Delete all notifications
• markAllAsRead - Mark all notifications as read
• archiveAllRead - Archive all read notifications
• markAsSeen - Mark notifications as seen
• getFeed - Retrieve subscriber notifications ⚠️ Deprecated

Subscribers.Preferences

• bulkUpdate - Bulk update subscriber preferences

Subscribers.Topics

• list - Retrieve subscriber subscriptions

Subscribers.Messages

• updateAsSeen - Update notification action status ⚠️ Deprecated
• markAllAs - Update notifications state ⚠️ Deprecated

SubscribersCredentials

• append - Upsert provider credentials
• deleteProvider - Delete provider credentials

SubscribersMessages

• markAll - Update all notifications state ⚠️ Deprecated

SubscribersNotifications

• getUnseenCount - Retrieve unseen notifications count ⚠️ Deprecated

SubscribersPreferences

• list - Retrieve subscriber preferences

Topics

• list - List all topics
• create - Create a topic
• get - Retrieve a topic
• update - Update a topic
• delete - Delete a topic

Topics.Subscriptions

• list - List topic subscriptions
• create - Create topic subscriptions
• delete - Delete topic subscriptions
• getSubscription - Retrieve a topic subscription
• update - Update a topic subscription

TopicsSubscribers

• check - Check topic subscriber

Translations

• create - Create a translation
• retrieve - Retrieve a translation
• delete - Delete a translation
• upload - Upload translation files

Translations.Groups

• delete - Delete a translation group
• retrieve - Retrieve a translation group

Translations.Master

• retrieve - Retrieve master translations JSON
• import - Import master translations JSON
• upload - Upload master translations JSON file

Workflows

• create - Create a workflow
• list - List all workflows
• update - Update a workflow
• get - Retrieve a workflow
• delete - Delete a workflow
• patch - Update a workflow
• sync - Sync a workflow

Workflows.Steps

• generatePreview - Generate a step preview
• retrieve - Retrieve workflow step

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide an Options object built with a RetryConfig object to the call:

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;
use novu\Utils\Retry;

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

$triggerEventRequestDto = new Components\TriggerEventRequestDto(
    workflowId: 'workflow_identifier',
    payload: [
        'comment_id' => 'string',
        'post' => [
            'text' => 'string',
        ],
    ],
    overrides: new Components\Overrides(),
    to: 'SUBSCRIBER_ID',
    actor: '<value>',
    context: [
        'key' => 'org-acme',
    ],
);

$response = $sdk->trigger(
    triggerEventRequestDto: $triggerEventRequestDto,
    options: Utils\Options->builder()->setRetryConfig(
        new Retry\RetryConfigBackoff(
            initialInterval: 1,
            maxInterval:     50,
            exponent:        1.1,
            maxElapsedTime:  100,
            retryConnectionErrors: false,
        ))->build()

);

if ($response->triggerEventResponseDto !== null) {
    // handle response
}

If you'd like to override the default retry strategy for all operations that support retries, you can pass a RetryConfig object to the SDKBuilder->setRetryConfig function when initializing the SDK:

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;
use novu\Utils\Retry;

$sdk = novu\Novu::builder()
    ->setRetryConfig(
        new Retry\RetryConfigBackoff(
            initialInterval: 1,
            maxInterval:     50,
            exponent:        1.1,
            maxElapsedTime:  100,
            retryConnectionErrors: false,
        )
  )
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();

$triggerEventRequestDto = new Components\TriggerEventRequestDto(
    workflowId: 'workflow_identifier',
    payload: [
        'comment_id' => 'string',
        'post' => [
            'text' => 'string',
        ],
    ],
    overrides: new Components\Overrides(),
    to: 'SUBSCRIBER_ID',
    actor: '<value>',
    context: [
        'key' => 'org-acme',
    ],
);

$response = $sdk->trigger(
    triggerEventRequestDto: $triggerEventRequestDto
);

if ($response->triggerEventResponseDto !== null) {
    // handle response
}

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception.

By default an API error will raise a Errors\APIException exception, which has the following properties:

Property	Type	Description
$message	string	The error message
$statusCode	int	The HTTP status code
$rawResponse	?\Psr\Http\Message\ResponseInterface	The raw HTTP response
$body	string	The response content

When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the trigger method throws the following exceptions:

Error Type	Status Code	Content Type
Errors\PayloadValidationExceptionDto	400	application/json
Errors\ErrorDto	414	application/json
Errors\ErrorDto	401, 403, 404, 405, 409, 413, 415	application/json
Errors\ValidationErrorDto	422	application/json
Errors\ErrorDto	500	application/json
Errors\APIException	4XX, 5XX	*/*

Example

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;
use novu\Models\Errors;

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

try {
    $triggerEventRequestDto = new Components\TriggerEventRequestDto(
        workflowId: 'workflow_identifier',
        payload: [
            'comment_id' => 'string',
            'post' => [
                'text' => 'string',
            ],
        ],
        overrides: new Components\Overrides(),
        to: 'SUBSCRIBER_ID',
        actor: '<value>',
        context: [
            'key' => 'org-acme',
        ],
    );

    $response = $sdk->trigger(
        triggerEventRequestDto: $triggerEventRequestDto
    );

    if ($response->triggerEventResponseDto !== null) {
        // handle response
    }
} catch (Errors\PayloadValidationExceptionDtoThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errors\ErrorDtoThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errors\ErrorDtoThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errors\ValidationErrorDtoThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errors\ErrorDtoThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errors\APIException $e) {
    // handle default exception
    throw $e;
}

Server Selection

Select Server by Index

You can override the default server globally using the setServerIndex(int $serverIdx) builder method when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Description
0	https://api.novu.co
1	https://eu.api.novu.co

Example

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;

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

$triggerEventRequestDto = new Components\TriggerEventRequestDto(
    workflowId: 'workflow_identifier',
    payload: [
        'comment_id' => 'string',
        'post' => [
            'text' => 'string',
        ],
    ],
    overrides: new Components\Overrides(),
    to: 'SUBSCRIBER_ID',
    actor: '<value>',
    context: [
        'key' => 'org-acme',
    ],
);

$response = $sdk->trigger(
    triggerEventRequestDto: $triggerEventRequestDto
);

if ($response->triggerEventResponseDto !== null) {
    // handle response
}

Override Server URL Per-Client

The default server can also be overridden globally using the setServerUrl(string $serverUrl) builder method when initializing the SDK client instance. For example:

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;

$sdk = novu\Novu::builder()
    ->setServerURL('https://eu.api.novu.co')
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();

$triggerEventRequestDto = new Components\TriggerEventRequestDto(
    workflowId: 'workflow_identifier',
    payload: [
        'comment_id' => 'string',
        'post' => [
            'text' => 'string',
        ],
    ],
    overrides: new Components\Overrides(),
    to: 'SUBSCRIBER_ID',
    actor: '<value>',
    context: [
        'key' => 'org-acme',
    ],
);

$response = $sdk->trigger(
    triggerEventRequestDto: $triggerEventRequestDto
);

if ($response->triggerEventResponseDto !== null) {
    // handle response
}

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy