README.md

Messages

(messages)

Overview

A message in Novu represents a notification delivered to a recipient on a particular channel. Messages contain information about the request that triggered its delivery, a view of the data sent to the recipient, and a timeline of its lifecycle events. Learn more about messages. https://docs.novu.co/workflows/messages

Available Operations

• delete - Delete message
• deleteByTransactionId - Delete messages by transactionId
• get - Get messages

delete

Deletes a message entity from the Novu platform

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;

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



$response = $sdk->messages->delete(
    messageId: '<id>',
    idempotencyKey: '<value>'

);

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

Parameters

Parameter	Type	Required	Description
messageId	string	✔️	N/A
idempotencyKey	?string	➖	A header for idempotency purposes

Response

?Operations\MessagesControllerDeleteMessageResponse

Errors

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

deleteByTransactionId

Deletes messages entity from the Novu platform using TransactionId of message

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Operations;

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



$response = $sdk->messages->deleteByTransactionId(
    transactionId: '<id>',
    channel: Operations\Channel::Push,
    idempotencyKey: '<value>'

);

if ($response->statusCode === 200) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
transactionId	string	✔️	N/A
channel	?Operations\Channel	➖	The channel of the message to be deleted
idempotencyKey	?string	➖	A header for idempotency purposes

Response

?Operations\MessagesControllerDeleteMessagesByTransactionIdResponse

Errors

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

get

Returns a list of messages, could paginate using the page query parameter

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Operations;

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

$request = new Operations\MessagesControllerGetMessagesRequest();

$response = $sdk->messages->get(
    request: $request
);

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

Parameters

Parameter	Type	Required	Description
$request	Operations\MessagesControllerGetMessagesRequest	✔️	The request object to use for the request.

Response

?Operations\MessagesControllerGetMessagesResponse

Errors

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