> 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/membership/integrations/providers/x.md).

# X (Twitter)

Connect X (Twitter) to Membership — let your users sign in with X.

Lets your users sign in with their X account, through an app in the X developer console.

## Get your credentials

1. Sign in to the X developer console ([console.x.com](https://console.x.com)) and press **Create App**. Give the name, description and use case.
2. Open **Keys and tokens** and copy the **API Key** and the **API Key Secret** (the consumer keys). They are shown only once — store them at once.
3. Under the user authentication settings, add your app's callback URL to the allowlist. It must match exactly, trailing slash included; use `https://` in production.

Source: X, [Developer apps](https://docs.x.com/fundamentals/developer-apps).

## Connect it in Cloud

**Where:** Membership → Integrations → **Add New Integration** → X (Twitter) → **Connect** · `/projects/<project>/membership/integrations/new/x`

Fill the form and press **Save**. The form stays open as **Editing X integration** with the **ENABLED** badge and the new id (`int_2FDHQBCdPdhqykkcyTXzfx`).

| Field            | Required  | What it does                                                          | Example                          |
| ---------------- | --------- | --------------------------------------------------------------------- | -------------------------------- |
| API Key          | yes (new) | The consumer API key.                                                 | `example-api-key`                |
| API Secret Key   | yes       | The consumer API key secret. Encrypted on save and never shown again. | `example-not-a-secret` (made up) |
| Integration Name | yes       | The name in your integrations list.                                   | `X sign-in`                      |

**OAuth Modes** — press **Add OAuth mode** for each surface of your app (web, mobile, admin) that signs in with this provider:

| Field                                      | Required | What it does                                       | Example                                    |
| ------------------------------------------ | -------- | -------------------------------------------------- | ------------------------------------------ |
| Mode name                                  | yes      | A name for the surface.                            | `web`                                      |
| Callback URL                               | yes      | Where the user lands in your app after signing in. | `https://app.example.com/auth/x/callback`  |
| Logout URL (optional)                      | no       | Where the user lands after signing out.            | —                                          |
| Failure redirect URL (optional)            | no       | Where the user lands when the sign-in fails.       | `https://app.example.com/sign-in?failed=1` |
| Role to assign on first sign-in (optional) | no       | The role a new user gets on the first sign-in.     | —                                          |

<figure><img src="https://712692422-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHy372bqsaex2cqS3ikhL%2Fuploads%2Fgit-blob-46c9d900ab3f210632e1730451a24f294b83a2f9%2Fx-form-1.png?alt=media" alt="New X Integration form: API Key example-api-key, a hidden API Secret Key, Integration Name X sign-in"><figcaption><p>The filled form.</p></figcaption></figure>

<figure><img src="https://712692422-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHy372bqsaex2cqS3ikhL%2Fuploads%2Fgit-blob-5324e4ed2c212561e3297dccc808ffc5da1a0693%2Fx-form-2.png?alt=media" alt="OAuth Modes with one mode: Mode name web, Callback URL https://app.example.com/auth/x/callback, Failure redirect URL https://app.example.com/sign-in?failed=1, and Add OAuth mode"><figcaption><p>One OAuth mode for the web app.</p></figcaption></figure>

<figure><img src="https://712692422-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHy372bqsaex2cqS3ikhL%2Fuploads%2Fgit-blob-3f400745cb6997bb610994960d7a61d9fb1cfeef%2Fx-saved-3.png?alt=media" alt="Editing X integration after save: the ENABLED badge, the id int_2FDHQBCdPdhqykkcyTXzfx, the provider fields empty and the Integration Name X sign-in"><figcaption><p>After save.</p></figcaption></figure>

{% hint style="warning" %}
Two things to know today. **(1)** When you open a saved integration, its fields come back empty — only the name and the state load, and the saved OAuth modes are not shown — so type every value again before you press **Save** on it. **(2)** No Norbix sign-in endpoint uses membership integrations yet: saving stores the settings, but your users cannot sign in with X through the API until it ships.
{% endhint %}

## Test and set as default

Membership integrations have no **Test** and no **Set as default** in Cloud — see [Test an integration](/codemash/cloud/membership/integrations/test.md) and [Set an integration as default](/codemash/cloud/membership/integrations/set-default.md). Check the values against the provider's console; **Actions → Disable** turns the integration off — see [Disable or delete an integration](/codemash/cloud/membership/integrations/disable.md).

## Common errors

| Message                                          | Cause                                                | Fix                                                     |
| ------------------------------------------------ | ---------------------------------------------------- | ------------------------------------------------------- |
| *Required* under a field                         | A required field is empty.                           | Fill it; on a saved integration, type the secret again. |
| Secret is not provided (`CM-ERRORS-SECRETS-001`) | Saved from code without the secret.                  | Send the secret on every save.                          |
| *Callback URL not approved* (at X)               | The callback URL is not in the allowlist of the app. | Add the exact URL in the user authentication settings.  |

Messages marked *(at …)* are the provider's own, shown to the user while signing in; see the [provider documentation](https://docs.x.com/fundamentals/developer-apps).

## Do it from code

```sh
norbix hub membership integration save --integration '{"provider":"X","integrationName":"X (staging)","isEnabled":true,"apiKey":"your-x-api-key","apiSecretKey":"your-x-api-secret-key"}'
```

With the SDK, send the same object as `integration` to `saveMembershipIntegration` — see the run example on [Providers](/codemash/cloud/membership/integrations/providers.md#do-it-from-code) and in [Save Membership Integration](/codemash/sdks/membership/integrations/save-membership-integration.md). Send `isEnabled: true`; to update, add the id as `integrationId` and the secret again. API: [Save Membership Integration](/codemash/api-reference/membership/integrations/save-membership-integration.md)