---
url: https://relizy.dev/typedoc/interfaces/TeamsSocialConfig.md
---
[relizy](../index.md) / TeamsSocialConfig

# Interface: TeamsSocialConfig

Defined in: [src/types.ts:1331](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L1331)

The content of the announcement of a version. The texts accept the
variables of the announcement (see `SocialAnnouncementVariables`).

## Extends

* [`SocialAnnouncementContent`](SocialAnnouncementContent.md)

## Properties

### announcements?

> `optional` **announcements?**: [`SocialAnnouncement`](../type-aliases/SocialAnnouncement.md)\[]

Defined in: [src/types.ts:1378](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L1378)

The versions to announce and their content. Without it, every version is
announced with the content of `social.teams`; with it, only the versions
matching an entry.

***

### badge?

> `optional` **badge?**: `string` | `false`

Defined in: [src/types.ts:1367](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L1367)

Text of the badge above the title; `false` removes it

#### Default

```ts
'New release' ('Prerelease' for a prerelease)
```

***

### cards?

> `optional` **cards?**: [`TeamsCardsMode`](../type-aliases/TeamsCardsMode.md)

Defined in: [src/types.ts:1354](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L1354)

One card per version, or one card for the release

#### Default

```ts
'version'
```

***

### changelog?

> `optional` **changelog?**: [`SocialChangelog`](../type-aliases/SocialChangelog.md)

Defined in: [src/types.ts:1362](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L1362)

The changelog in the card: `full` (the commit bodies included), `summary`
(the commit titles, rewritten with `ai.social.teams`), or `none` (or
`false`), the buttons linking to it. Cut between two changes to fit in the
28 KB of a card.

#### Default

```ts
'none'
```

***

### changelogUrl?

> `optional` **changelogUrl?**: `string` | `false`

Defined in: [src/types.ts:1259](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L1259)

URL of the changelog link of the version; `false` removes the link

#### Inherited from

[`SocialAnnouncementContent`](SocialAnnouncementContent.md).[`changelogUrl`](SocialAnnouncementContent.md#changelogurl)

***

### enabled?

> `optional` **enabled?**: `boolean`

Defined in: [src/types.ts:1336](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L1336)

Enable the Teams cards

#### Default

```ts
false
```

***

### exclude?

> `optional` **exclude?**: [`SocialExclude`](SocialExclude.md)

Defined in: [src/types.ts:1382](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L1382)

Versions never announced, even when an announcement matches them

***

### links?

> `optional` **links?**: [`SocialLink`](SocialLink.md)\[]

Defined in: [src/types.ts:1263](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L1263)

Links added after the release notes and the changelog

#### Inherited from

[`SocialAnnouncementContent`](SocialAnnouncementContent.md).[`links`](SocialAnnouncementContent.md#links)

***

### locale?

> `optional` **locale?**: `string`

Defined in: [src/types.ts:1372](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L1372)

Locale of the date of the card (BCP 47, e.g. `fr-FR`)

#### Default

```ts
'en-US'
```

***

### message?

> `optional` **message?**: `string`

Defined in: [src/types.ts:1255](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L1255)

Text under the title, in markdown (bold, italic, links, lists)

#### Inherited from

[`SocialAnnouncementContent`](SocialAnnouncementContent.md).[`message`](SocialAnnouncementContent.md#message)

***

### onlyStable?

> `optional` **onlyStable?**: `boolean`

Defined in: [src/types.ts:1341](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L1341)

Skip the prerelease versions (alpha, beta, rc, etc.)

#### Default

```ts
true
```

***

### title?

> `optional` **title?**: `string`

Defined in: [src/types.ts:1251](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L1251)

Title of the version: of its Teams card (or section), of its Slack section
(or header, when the message announces a single version)

#### Inherited from

[`SocialAnnouncementContent`](SocialAnnouncementContent.md).[`title`](SocialAnnouncementContent.md#title)

***

### webhookUrl?

> `optional` **webhookUrl?**: `string`

Defined in: [src/types.ts:1349](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L1349)

URL of the Teams workflow ("When a Teams webhook request is received"
trigger). It holds a secret (`sig`): prefer the environment.
Env fallback: RELIZY_TEAMS_WEBHOOK_URL, TEAMS_WEBHOOK_URL, or the URL in
base64 in RELIZY_TEAMS_WEBHOOK_URL_B64, TEAMS_WEBHOOK_URL_B64 (a masked
GitLab variable refuses the characters of the URL).