testNotificationChannel()
Home > @gooddata/sdk-backend-spi > IOrganizationNotificationChannelService > testNotificationChannel
IOrganizationNotificationChannelService.testNotificationChannel() method
This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Test notification channel
Signature:
testNotificationChannel(channel: INotificationChannelMetadataObjectDefinition, externalRecipients?: INotificationChannelExternalRecipient[]): Promise<INotificationChannelTestResponse>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| channel | INotificationChannelMetadataObjectDefinition | definition of the channel |
| externalRecipients | INotificationChannelExternalRecipient[] | (Optional) external recipients of the test result |
Returns:
Promise<INotificationChannelTestResponse>
Promise resolved with test response.