> For the complete documentation index, see [llms.txt](https://codemash.gitbook.io/codemash/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://codemash.gitbook.io/codemash/cloud/sms/integrations/providers/bird.md).

# Bird

Connect Bird to SMS — coming soon; Norbix cannot send through Bird yet.

Bird (formerly MessageBird) is an omnichannel platform with an SMS API and a global carrier network.

{% hint style="warning" %}
Cloud has no screen for this yet. On **Add New Integration** the Bird card shows **COMING SOON**, the note *Sending SMS through Bird is not supported yet.* and a turned-off **Connect** button, and Norbix refuses every send and every test through Bird (`CM-ERRORS-SMS-005`, *Sending SMS through Bird is not supported yet. Use Twilio or the Fake provider.*). To send SMS today, use [Twilio](/codemash/cloud/sms/integrations/providers/twilio.md), or [Fake SMS (Test Me)](/codemash/cloud/sms/integrations/providers/fake-sms.md) for practice. The settings below can already be saved with the SDK, the CLI or the API.
{% endhint %}

<figure><img src="https://712692422-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHy372bqsaex2cqS3ikhL%2Fuploads%2Fgit-blob-94d4306d62d72ced84f04e3230b7f12d29264b59%2Fbird-card-1.png?alt=media" alt="The Bird card on Select SMS Integration: COMING SOON badge, a grey Connect button and the note Sending SMS through Bird is not supported yet."><figcaption><p>The Bird card is not connectable yet.</p></figcaption></figure>

## Get your credentials

1. Sign in to the [Bird dashboard](https://app.bird.com/).
2. Under **Settings → Access keys** create an **API key**.
3. Note your workspace **region** (for example `eu`) and pick an originator: a number in E.164 format or an alphanumeric name.

## Connect it in Cloud

**Where:** SMS → Integrations → **Add New Integration** → Bird — **Connect** is turned off for now.

The form exists in Cloud and opens only by its address, `/projects/<project>/sms/integrations/new/bird`; it starts with the note *Sending SMS through Bird is not supported yet.* An integration saved there (or from code) stays in the [integrations list](/codemash/cloud/sms/integrations.md) with **SENDING NOT SUPPORTED YET**, can be edited and deleted, and is not offered on campaigns, trigger actions or template tests.

| Field            | Required | What it does                                        | Example             |
| ---------------- | -------- | --------------------------------------------------- | ------------------- |
| Originator       | yes      | The number or alphanumeric name the SMS comes from. | `Acme`              |
| Region           | yes      | The region of your Bird workspace.                  | `eu`                |
| API Key          | yes      | Secret; encrypted on save and never shown again.    | `your-bird-api-key` |
| Integration Name | yes      | The name in your integrations list.                 | `Bird production`   |

<figure><img src="https://712692422-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHy372bqsaex2cqS3ikhL%2Fuploads%2Fgit-blob-c4b5eae9414606d2a2438201503186b31a24b56c%2Fbird-form-1.png?alt=media" alt="New Bird Integration form with the note Sending SMS through Bird is not supported yet. and the empty fields"><figcaption><p>The Bird form, opened by its address.</p></figcaption></figure>

## Test and set as default

**Test integration** answers *Test failed* with `Sending SMS through Bird is not supported yet. Use Twilio or the Fake provider.`, and the integration is not offered as a sender, so setting it as default has no use yet. See [Test an integration](/codemash/cloud/sms/integrations/test.md) and [Set an integration as default](/codemash/cloud/sms/integrations/set-default.md) for the flow once Bird goes live.

## Common errors

| Message                                                                         | Cause                                  | Fix                                                                                                                                                 |
| ------------------------------------------------------------------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| Sending SMS through Bird is not supported yet. Use Twilio or the Fake provider. | Every send or test through Bird today. | Use [Twilio](/codemash/cloud/sms/integrations/providers/twilio.md) or [Fake SMS (Test Me)](/codemash/cloud/sms/integrations/providers/fake-sms.md). |
| Secret is not provided (`CM-ERRORS-SECRETS-001`)                                | An update without the secret fields.   | Send every secret again on each save.                                                                                                               |
| Required                                                                        | An empty field on the form.            | Fill every field.                                                                                                                                   |

## Do it from code

```ts
const { id } = await norbix.hub.notifications.saveSmsIntegration({
  integration: {
    provider: 'Bird',
    integrationName: 'Bird production',
    isEnabled: true,
    originator: 'Acme',
    region: 'eu',
    apiKey: 'your-bird-api-key',
  } as any, // the TS type knows only the shared fields
});
```

```sh
norbix hub notifications sms integration save --integration '{"provider":"Bird","integrationName":"Bird production","isEnabled":true,"originator":"Acme","region":"eu","apiKey":"your-bird-api-key"}'
```

The client setup is on the [SMS page](/codemash/cloud/sms.md#use-it-from-code). API: [Save Sms Integration](/codemash/api-reference/notifications/sms/save-sms-integration.md)