> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IOrganizationNotificationChannelService

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Stability: beta
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/organization/notificationChannels/index.ts

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

This service provides access to organization notifications channels.

**Signature:**

```typescript
export interface IOrganizationNotificationChannelService 
```

## Methods

| Method | Description |
| --- | --- |
| [createNotificationChannel(notificationChannel)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationnotificationchannelservice/index.md#iorganizationnotificationchannelservicecreatenotificationchannel) | **_(BETA)_** |
| [deleteNotificationChannel(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationnotificationchannelservice/index.md#iorganizationnotificationchannelservicedeletenotificationchannel) | **_(BETA)_** Delete notification channel |
| [getNotificationChannel(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationnotificationchannelservice/index.md#iorganizationnotificationchannelservicegetnotificationchannel) | **_(BETA)_** |
| [getNotificationChannelsQuery()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationnotificationchannelservice/index.md#iorganizationnotificationchannelservicegetnotificationchannelsquery) | **_(BETA)_** Query list of notification channels |
| [testNotificationChannel(channel, externalRecipients)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationnotificationchannelservice/index.md#iorganizationnotificationchannelservicetestnotificationchannel) | **_(BETA)_** Test notification channel |
| [updateNotificationChannel(notificationChannel)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationnotificationchannelservice/index.md#iorganizationnotificationchannelserviceupdatenotificationchannel) | **_(BETA)_** Update existing notification channel |

## Method details

### IOrganizationNotificationChannelService.createNotificationChannel()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
createNotificationChannel(notificationChannel: INotificationChannelMetadataObjectDefinition): Promise<INotificationChannelMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| notificationChannel | [INotificationChannelMetadataObjectDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchannelmetadataobjectdefinition/index.md) |  |

**Returns:**

Promise&lt;[INotificationChannelMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchannelmetadataobject/index.md)&gt;

### IOrganizationNotificationChannelService.deleteNotificationChannel()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Delete notification channel

**Signature:**

```typescript
deleteNotificationChannel(id: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | id of the notification channel |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the notification channel is deleted.

### IOrganizationNotificationChannelService.getNotificationChannel()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
getNotificationChannel(id: string): Promise<INotificationChannelMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string |  |

**Returns:**

Promise&lt;[INotificationChannelMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchannelmetadataobject/index.md)&gt;

### IOrganizationNotificationChannelService.getNotificationChannelsQuery()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Query list of notification channels

**Signature:**

```typescript
getNotificationChannelsQuery(): INotificationChannelsQuery;
```
**Returns:**

[INotificationChannelsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelsquery/index.md)

### IOrganizationNotificationChannelService.testNotificationChannel()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Test notification channel

**Signature:**

```typescript
testNotificationChannel(channel: INotificationChannelMetadataObjectDefinition, externalRecipients?: INotificationChannelExternalRecipient[]): Promise<INotificationChannelTestResponse>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| channel | [INotificationChannelMetadataObjectDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchannelmetadataobjectdefinition/index.md) | definition of the channel |
| externalRecipients | [INotificationChannelExternalRecipient](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchannelexternalrecipient/index.md)[] | _(Optional)_ external recipients of the test result |

**Returns:**

Promise&lt;[INotificationChannelTestResponse](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchanneltestresponse/index.md)&gt;

Promise resolved with test response.

### IOrganizationNotificationChannelService.updateNotificationChannel()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Update existing notification channel

**Signature:**

```typescript
updateNotificationChannel(notificationChannel: INotificationChannelMetadataObject): Promise<INotificationChannelMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| notificationChannel | [INotificationChannelMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchannelmetadataobject/index.md) | definition of the notification channel |

**Returns:**

Promise&lt;[INotificationChannelMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchannelmetadataobject/index.md)&gt;

Promise resolved with updated notification channel.