Skip to content

README.md

Latest commit

 

History

History
149 lines (111 loc) · 7.59 KB

README.md

File metadata and controls

149 lines (111 loc) · 7.59 KB

Workflows.Steps

Overview

Available Operations

generatePreview

Generates a preview for a specific workflow step by its unique identifier stepId

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;

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

$generatePreviewRequestDto = new Components\GeneratePreviewRequestDto(
    previewPayload: new Components\PreviewPayloadDto(
        subscriber: new Components\SubscriberResponseDtoOptional(
            channels: [
                new Components\ChannelSettingsDto(
                    providerId: Components\ChatOrPushProviderEnum::NovuSlack,
                    credentials: new Components\ChannelCredentials(
                        webhookUrl: 'https://example.com/webhook',
                        channel: 'general',
                        deviceTokens: [
                            'token1',
                            'token2',
                            'token3',
                        ],
                        alertUid: '12345-abcde',
                        title: 'Critical Alert',
                        imageUrl: 'https://example.com/image.png',
                        state: 'resolved',
                        externalUrl: 'https://example.com/details',
                    ),
                    integrationId: '<id>',
                ),
            ],
        ),
        context: [
            'key' => 'org-acme',
        ],
    ),
);

$response = $sdk->workflows->steps->generatePreview(
    workflowId: '<id>',
    stepId: '<id>',
    generatePreviewRequestDto: $generatePreviewRequestDto

);

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

Parameters

Parameter Type Required Description
workflowId string ✔️ N/A
stepId string ✔️ N/A
generatePreviewRequestDto Components\GeneratePreviewRequestDto ✔️ Preview generation details
idempotencyKey ?string ➖ A header for idempotency purposes

Response

?Operations\WorkflowControllerGeneratePreviewResponse

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 */*

retrieve

Retrieves data for a specific step in a workflow

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;

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



$response = $sdk->workflows->steps->retrieve(
    workflowId: '<id>',
    stepId: '<id>'

);

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

Parameters

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

Response

?Operations\WorkflowControllerGetWorkflowStepDataResponse

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 */*