AdvertisingOAuth 1.0a — consumer key/secret + user access token/secretConfirm pricing before publishing
X (Twitter) Ads API
X Ads accounts: sync metrics and manage campaigns.
AProvider definition
- Provider
- X (Twitter) Ads API
- What it does
- X Ads accounts (requires approved Ads API access). Connect each ad account with the access token and secret of a user who can manage it.
- Why we need it
- X Ads accounts: sync metrics and manage campaigns.
- Used in
- Performance ads
BAccount requirements
- Account type
- X developer app with approved Ads API access
- Prerequisites
- X Ads account
CConnection method
- Authentication
- OAuth 1.0a — consumer key/secret + user access token/secret
- Where to enter it
- Your workspace: App → Integrations → Providers & API keysWorkspace owner or admin. Keys added here are used only by your workspace (AI keys here don't use plan credits).
- Ad accounts: App → Performance ads → Ad accountsConnect each ad account with OAuth, or paste an access token.
Setup steps
- 1Apply for Ads API access for your X developer app.
- 2Generate the user's access token and secret for an account that can manage the ad account.
- 3Enter the consumer key/secret in Integrations and the access token/secret per ad account.
DPermissions & API scopes
Scopes are granted on the provider's side when you authorise the app.
This list is generated from the scopes the application's code requests.
EFree vs paid
- Free account / free API access
- Requires approved Ads API access.
- Card or billing account required?
- Not for the API.
- Paid plan / costs
- None.
- Quota and usage limits
- Provider-specific rate limits.
Not yet verified. Confirm on the provider's official pricing page before publishing.
FSetup screenshots
Capture each step with real values masked. Save images as public/docs/integrations/x_ads/1.png … 10.png and they appear here automatically.
- Screenshot to add1. Account login / creationThe provider's sign-in or sign-up page.
- Screenshot to add2. Developer consoleThe developer console or dashboard home.
- Screenshot to add3. Project / app creationCreating the app or project used for this integration.
- Screenshot to add4. API enablementThe API or product enabled for the project.
- Screenshot to add5. OAuth configurationConsent screen / OAuth settings with the redirect URIs.
- Screenshot to add6. API key / credentials creationCreating the key, secret or token (mask the value).
- Screenshot to add7. Permissions / scopesThe scopes or permissions requested or approved.
- Screenshot to add8. Billing / quota settingsBilling, credits or quota page.
- Screenshot to add9. Application connectionThe provider card in our application with fields filled (secrets masked).
- Screenshot to add10. Successful connectionThe green Test result or the connected account listed.
GApplication configuration
Never include real API keys, client secrets, access tokens or passwords in screenshots, tickets or documentation. Values below are field names and examples only.
| Field | Required | Example / default | Notes |
|---|---|---|---|
| API key (consumer key) | Yes | — | |
| API key secret | Yes | •••••••• | Stored encrypted; shown masked after saving. |
Connecting an ad account (X Ads)
Covers Promoted posts on X. Connect by pasting a token:
- • Access token (required)
- • Access token secret (required)
- • Ads account ID (required)
HTesting
- 1Connect an ad account and check spend appears.
ITroubleshooting
| Problem | What to do |
|---|---|
| Invalid credentials | Check the Client ID/App ID and secret were copied from the same app, without spaces. Regenerate the secret if unsure. |
| Missing permissions | Reconnect and accept every permission on the consent screen. If a permission is missing from the list, add it to the app (and get it approved). |
| OAuth failure | Sign-in was cancelled, the app is in development/testing mode, or the user isn't allowed to use it yet. Add the user as a tester or publish the app. |
| Redirect URI mismatch | Copy the redirect URI from section G exactly — same https scheme, host and path, no trailing slash — into the provider's app settings. |
| API not enabled | Enable the API/product for the project or app in the provider console and wait a few minutes. |
| Quota exceeded | Wait for the quota window to reset (see section E) or request a higher quota / add credits. |
| Account not eligible | Check the account requirements in section B (e.g. business/professional account, verified property, registered organisation). |
| App review required | Permissions beyond development access need the provider's review before other accounts can connect. See section E for restrictions. |
| Billing required | Add a payment method or prepaid credits on the provider account (see section E). |
JDisconnect & security
- Revoke access at the provider
- Revoke the app's access in X settings and regenerate tokens.
- Disconnect in the application
- App → Integrations → Providers & API keys or App → Performance ads → Ad accounts → open the card → Remove / Disconnect. Connected accounts can be disconnected per brand.
- Rotate credentials
- Create the new key or secret first, paste it into the same card and Test, then delete the old one at the provider — no downtime.
- How credentials are stored
- Encrypted at rest with AES-256-GCM using the server's ENCRYPTION_KEY, shown masked after saving, never returned to the browser, and used only from the API server.
- What data the application can access
- Ad accounts, campaigns and stats.

