Python Client SDK Generated by Speakeasy.
Project description
The <Inbox /> infrastructure for modern products
Python Novu SDK
The Python Novu SDK and package provides a fluent and expressive interface for interacting with Novu's API and managing notifications.
## 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
SDK Installation
[!NOTE] Python version upgrade policy
Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
The SDK can be installed with uv, pip, or poetry package managers.
uv
uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.
uv add novu-py
PIP
PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
pip install novu-py
Poetry
Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.
poetry add novu-py
Shell and script usage with uv
You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:
uvx --from novu-py python
It's also possible to write a standalone Python script without needing to set up a whole project like so:
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.10"
# dependencies = [
# "novu-py",
# ]
# ///
from novu_py import Novu
sdk = Novu(
# SDK arguments
)
# Rest of script here...
Once that is saved to a file, you can run it with uv run script.py where
script.py can be replaced with the actual file name.
IDE Support
PyCharm
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
SDK Example Usage
Trigger Notification Event
# Synchronous Example
import novu_py
from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.trigger(trigger_event_request_dto=novu_py.TriggerEventRequestDto(
workflow_id="workflow_identifier",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.Overrides(),
to="SUBSCRIBER_ID",
actor="<value>",
context={
"key": "org-acme",
},
))
# Handle response
print(res)
The same SDK client can also be used to make asynchronous requests by importing asyncio.
# Asynchronous Example
import asyncio
import novu_py
from novu_py import Novu
async def main():
async with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = await novu.trigger_async(trigger_event_request_dto=novu_py.TriggerEventRequestDto(
workflow_id="workflow_identifier",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.Overrides(),
to="SUBSCRIBER_ID",
actor="<value>",
context={
"key": "org-acme",
},
))
# Handle response
print(res)
asyncio.run(main())
Cancel Triggered Event
# Synchronous Example
from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.cancel(transaction_id="<id>")
# Handle response
print(res)
The same SDK client can also be used to make asynchronous requests by importing asyncio.
# Asynchronous Example
import asyncio
from novu_py import Novu
async def main():
async with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = await novu.cancel_async(transaction_id="<id>")
# Handle response
print(res)
asyncio.run(main())
Broadcast Event to All
# Synchronous Example
import novu_py
from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.trigger_broadcast(trigger_event_to_all_request_dto=novu_py.TriggerEventToAllRequestDto(
name="<value>",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.TriggerEventToAllRequestDtoOverrides(
**{
"fcm": {
"data": {
"key": "value",
},
},
},
),
actor=novu_py.SubscriberPayloadDto(
first_name="John",
last_name="Doe",
email="john.doe@example.com",
phone="+1234567890",
avatar="https://example.com/avatar.jpg",
locale="en-US",
timezone="America/New_York",
subscriber_id="<id>",
),
context={
"key": "org-acme",
},
))
# Handle response
print(res)
The same SDK client can also be used to make asynchronous requests by importing asyncio.
# Asynchronous Example
import asyncio
import novu_py
from novu_py import Novu
async def main():
async with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = await novu.trigger_broadcast_async(trigger_event_to_all_request_dto=novu_py.TriggerEventToAllRequestDto(
name="<value>",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.TriggerEventToAllRequestDtoOverrides(
**{
"fcm": {
"data": {
"key": "value",
},
},
},
),
actor=novu_py.SubscriberPayloadDto(
first_name="John",
last_name="Doe",
email="john.doe@example.com",
phone="+1234567890",
avatar="https://example.com/avatar.jpg",
locale="en-US",
timezone="America/New_York",
subscriber_id="<id>",
),
context={
"key": "org-acme",
},
))
# Handle response
print(res)
asyncio.run(main())
Trigger Notification Events in Bulk
# Synchronous Example
import novu_py
from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.trigger_bulk(bulk_trigger_event_dto={
"events": [
novu_py.TriggerEventRequestDto(
workflow_id="workflow_identifier",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.Overrides(),
to="SUBSCRIBER_ID",
),
novu_py.TriggerEventRequestDto(
workflow_id="workflow_identifier",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.Overrides(),
to="SUBSCRIBER_ID",
),
novu_py.TriggerEventRequestDto(
workflow_id="workflow_identifier",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.Overrides(),
to="SUBSCRIBER_ID",
),
],
})
# Handle response
print(res)
The same SDK client can also be used to make asynchronous requests by importing asyncio.
# Asynchronous Example
import asyncio
import novu_py
from novu_py import Novu
async def main():
async with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = await novu.trigger_bulk_async(bulk_trigger_event_dto={
"events": [
novu_py.TriggerEventRequestDto(
workflow_id="workflow_identifier",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.Overrides(),
to="SUBSCRIBER_ID",
),
novu_py.TriggerEventRequestDto(
workflow_id="workflow_identifier",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.Overrides(),
to="SUBSCRIBER_ID",
),
novu_py.TriggerEventRequestDto(
workflow_id="workflow_identifier",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.Overrides(),
to="SUBSCRIBER_ID",
),
],
})
# Handle response
print(res)
asyncio.run(main())
Available Resources and Operations
Available methods
Novu SDK
- trigger - Trigger event
- cancel - Cancel triggered event
- trigger_broadcast - Broadcast event to all
- trigger_bulk - 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
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
- get_tags - 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
- integrations_controller_auto_configure_integration - Auto-configure an integration for inbound webhooks
- set_as_primary - Update integration as primary
- list_active - List active integrations
- generate_chat_o_auth_url - Generate chat OAuth URL
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
- generate_preview - Generate layout preview
- usage - Get layout usage
Messages
- retrieve - List all messages
- delete - Delete a message
- delete_by_transaction_id - Delete messages by transactionId
Notifications
Subscribers
- search - Search subscribers
- create - Create a subscriber
- retrieve - Retrieve a subscriber
- patch - Update a subscriber
- delete - Delete a subscriber
- create_bulk - Bulk create subscribers
Subscribers.Credentials
- update - Update provider credentials
- append - Upsert provider credentials
- delete - Delete provider credentials
Subscribers.Messages
- update_as_seen - Update notification action status
- mark_all - Update all notifications state
- mark_all_as - Update notifications state
Subscribers.Notifications
- list - Retrieve subscriber notifications
- delete - Delete a notification
- complete_action - Complete a notification action
- revert_action - Revert a notification action
- archive - Archive a notification
- mark_as_read - Mark a notification as read
- snooze - Snooze a notification
- unarchive - Unarchive a notification
- mark_as_unread - Mark a notification as unread
- unsnooze - Unsnooze a notification
- archive_all - Archive all notifications
- count - Retrieve subscriber notifications count
- delete_all - Delete all notifications
- mark_all_as_read - Mark all notifications as read
- archive_all_read - Archive all read notifications
- mark_as_seen - Mark notifications as seen
- feed - Retrieve subscriber notifications
- unseen_count - Retrieve unseen notifications count
Subscribers.Preferences
- list - Retrieve subscriber preferences
- update - Update subscriber preferences
- bulk_update - Bulk update subscriber preferences
Subscribers.Properties
- update_online_flag - Update subscriber online status
Subscribers.Topics
- list - Retrieve subscriber subscriptions
Topics
- list - List all topics
- create - Create a topic
- get - Retrieve a topic
- update - Update a topic
- delete - Delete a topic
Topics.Subscribers
- retrieve - Check topic subscriber
Topics.Subscriptions
- list - List topic subscriptions
- create - Create topic subscriptions
- delete - Delete topic subscriptions
- get_subscription - Retrieve a topic subscription
- update - Update a topic subscription
Translations
- create - Create a translation
- retrieve - Retrieve a translation
- delete - Delete a translation
- upload - Upload translation files
Translations.Groups
Translations.Master
- retrieve - Retrieve master translations JSON
- import_master_json - 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
- generate_preview - Generate a step preview
- retrieve - Retrieve workflow step
File uploads
Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
[!TIP]
For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
import novu_py
from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.translations.upload(request_body={
"resource_id": "welcome-email",
"resource_type": novu_py.TranslationControllerUploadTranslationFilesResourceType.WORKFLOW,
"files": [],
})
# Handle response
print(res)
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 a RetryConfig object to the call:
import novu_py
from novu_py import Novu
from novu_py.utils import BackoffStrategy, RetryConfig
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.trigger(trigger_event_request_dto=novu_py.TriggerEventRequestDto(
workflow_id="workflow_identifier",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.Overrides(),
to="SUBSCRIBER_ID",
actor="<value>",
context={
"key": "org-acme",
},
),
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
# Handle response
print(res)
If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:
import novu_py
from novu_py import Novu
from novu_py.utils import BackoffStrategy, RetryConfig
with Novu(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.trigger(trigger_event_request_dto=novu_py.TriggerEventRequestDto(
workflow_id="workflow_identifier",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.Overrides(),
to="SUBSCRIBER_ID",
actor="<value>",
context={
"key": "org-acme",
},
))
# Handle response
print(res)
Error Handling
NovuError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
|---|---|---|
err.message |
str |
Error message |
err.status_code |
int |
HTTP response status code eg 404 |
err.headers |
httpx.Headers |
HTTP response headers |
err.body |
str |
HTTP body. Can be empty string if no body is returned. |
err.raw_response |
httpx.Response |
Raw HTTP response |
err.data |
Optional. Some errors may contain structured data. See Error Classes. |
Example
import novu_py
from novu_py import Novu, models
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = None
try:
res = novu.trigger(trigger_event_request_dto=novu_py.TriggerEventRequestDto(
workflow_id="workflow_identifier",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.Overrides(),
to="SUBSCRIBER_ID",
actor="<value>",
context={
"key": "org-acme",
},
))
# Handle response
print(res)
except models.NovuError as e:
# The base class for HTTP error responses
print(e.message)
print(e.status_code)
print(e.body)
print(e.headers)
print(e.raw_response)
# Depending on the method different errors may be thrown
if isinstance(e, models.PayloadValidationExceptionDto):
print(e.data.status_code) # float
print(e.data.timestamp) # str
print(e.data.path) # str
print(e.data.message) # OptionalNullable[novu_py.PayloadValidationExceptionDtoMessage]
print(e.data.ctx) # Optional[Dict[str, Any]]
Error Classes
Primary errors:
NovuError: The base class for HTTP error responses.ErrorDto: *ValidationErrorDto: Unprocessable Entity. Status code422. *
Less common errors (8)
Network errors:
httpx.RequestError: Base class for request errors.httpx.ConnectError: HTTP client was unable to make a request to a server.httpx.TimeoutException: HTTP request timed out.
Inherit from NovuError:
PayloadValidationExceptionDto: Status code400. Applicable to 3 of 118 methods.*SubscriberResponseDtoError: Created. Status code409. Applicable to 1 of 118 methods.*TopicResponseDtoError: OK. Status code409. Applicable to 1 of 118 methods.*ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via thecauseattribute.
* Check the method documentation to see if the error is applicable.
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the server_idx: int optional parameter 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
import novu_py
from novu_py import Novu
with Novu(
server_idx=0,
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.trigger(trigger_event_request_dto=novu_py.TriggerEventRequestDto(
workflow_id="workflow_identifier",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.Overrides(),
to="SUBSCRIBER_ID",
actor="<value>",
context={
"key": "org-acme",
},
))
# Handle response
print(res)
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
import novu_py
from novu_py import Novu
with Novu(
server_url="https://eu.api.novu.co",
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.trigger(trigger_event_request_dto=novu_py.TriggerEventRequestDto(
workflow_id="workflow_identifier",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.Overrides(),
to="SUBSCRIBER_ID",
actor="<value>",
context={
"key": "org-acme",
},
))
# Handle response
print(res)
Custom HTTP Client
The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.
For example, you could specify a header for every request that this sdk makes as follows:
from novu_py import Novu
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Novu(client=http_client)
or you could wrap the client with your own custom logic:
from novu_py import Novu
from novu_py.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = Novu(async_client=CustomClient(httpx.AsyncClient()))
Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
|---|---|---|---|
secret_key |
apiKey | API key | NOVU_SECRET_KEY |
To authenticate with the API the secret_key parameter must be set when initializing the SDK client instance. For example:
import novu_py
from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.trigger(trigger_event_request_dto=novu_py.TriggerEventRequestDto(
workflow_id="workflow_identifier",
payload={
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides=novu_py.Overrides(),
to="SUBSCRIBER_ID",
actor="<value>",
context={
"key": "org-acme",
},
))
# Handle response
print(res)
Resource Management
The Novu class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.
from novu_py import Novu
def main():
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
# Rest of application here...
# Or when using async:
async def amain():
async with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
# Rest of application here...
Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass your own logger class directly into your SDK.
from novu_py import Novu
import logging
logging.basicConfig(level=logging.DEBUG)
s = Novu(debug_logger=logging.getLogger("novu_py"))
You can also enable a default debug logger by setting an environment variable NOVU_DEBUG to true.
Development
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file novu_py-3.15.0.tar.gz.
File metadata
- Download URL: novu_py-3.15.0.tar.gz
- Upload date:
- Size: 220.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.1 CPython/3.10.20 Linux/6.8.0-1044-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b8944a74aa0a4d34036c6e353ecf9b1c733c93da9889870e12a90ecc147dc82e
|
|
| MD5 |
f42bed012ccbc3c2b1aec46bde9552f4
|
|
| BLAKE2b-256 |
0f30916b170978c08a1445eab2183f2f6d7f506ca7576038bf78aefbe21c2b26
|
File details
Details for the file novu_py-3.15.0-py3-none-any.whl.
File metadata
- Download URL: novu_py-3.15.0-py3-none-any.whl
- Upload date:
- Size: 558.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.1 CPython/3.10.20 Linux/6.8.0-1044-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f0b5fbe27de4f353506b584ddaba7020c3e557a6420f12033292f11355519657
|
|
| MD5 |
5131da89ce987989d06aa880907353b0
|
|
| BLAKE2b-256 |
324d4a360ec23204c600f477b211f295c873d858111febb8c92c7db453e67b92
|