# MessageBird

![messagebird-logo.svg](https://assets.relyanceuat.xyz/images/docs/9649208424333/9648994851341.svg)
MessageBird is a cloud-based communications platform that powers communication between businesses and their customers. It does this using a variety of channels including SMS, WhatsApp, voice, live chat and more.

In order to integrate MessageBird with Relyance AI you will need a MessageBird **API Key**.

#### In MessageBird:

1. Login to your MessageBird account.
2. Click on **Developers** in the left-hand navigation menu.
3. Click on **API access** on the resulting submenu.
4. Click on **+ Add access key**.
5. In the resulting dialog box, provide a meaningful description and ensure you choose **Live** in the dropdown.
6. Click **Add**.
7. This will create a new Access key. Click **Show key**.
8. Copy the **API Key** to be used in Relyance.

![MessageBird-1.png](https://assets.relyanceuat.xyz/images/docs/9649208424333/9649462282893.png)

![MessageBird-2.png](https://assets.relyanceuat.xyz/images/docs/9649208424333/9649462171789.png)

#### In the Relyance AI application:

1. Login to your Relyance account.
2. Navigate to the **Settings** Menu in the bottom left-hand side.
3. Select **Integrations**.
4. Click on the **Vendor Integration** tab.
5. Find the **MessageBird** integration card and click it to open its connections.
6. Under **Authentication Method**, choose **Custom**.
8. Paste the **API Key** into its respective field.

![MessageBird-4.png](https://assets.relyanceuat.xyz/images/docs/9649208424333/9649462103821.png)

The **Authentication** step asks for:

- **API Key**: required; held as a secret.

9. Click **Authenticate**.
10. At this point, you should see the following result on the **Vendor** Integrations page:

![MessageBird-5.png](https://assets.relyanceuat.xyz/images/docs/9649208424333/9649431479437.png)

11. Congratulations, you are now connected to **MessageBird**.

<!-- terraform-examples:begin (generated from the integration catalog; do not hand-edit) -->

## Manage this integration with Terraform

Connections for this integration can be managed as code with the [Relyance Terraform provider](https://registry.terraform.io/providers/Relyance/relyance/latest). Non-secret fields go in `auth.params`; secret fields go in `auth.secrets_wo`, which is write-only — never stored in Terraform state. Rotate secrets by bumping `auth.secrets_wo_version`.

```hcl
resource "relyance_integration_connection" "messagebird" {
  vendor = "messagebird"
  name   = "<your connection name>"

  auth = {
    method = "api-key"
    params = {
      data_storage_location = "us"
    }
    # Secret fields are write-only: sent to Relyance, never stored in state.
    secrets_wo = {
      api_key = var.messagebird_api_key
    }
    secrets_wo_version = 1
  }

  scans = { "property-inspection" = { enabled = true } }
}
```

<!-- terraform-examples:end -->