API Configuration

You can manage your X Ads connector programmatically using the Weld REST API. This page covers the key operations specific to X Ads.

Authentication

All API requests require an API key passed via the x-api-key header. You can create API keys in Settings → API Keys inside the Weld app.

curl https://connect.weld.app/connections \
  --header 'x-api-key: YOUR_API_KEY'

Integration ID

When creating connections or syncs for X Ads, use the following integration ID:

ParameterValue
integration_idxAds

Create a Connection

To connect X Ads via the API, create a connection bridge session:

curl https://connect.weld.app/connection_bridges \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '{
  "integration_id": "xAds",
  "label": "x-ads-production",
  "redirect_uri": "https://yourapp.com/callback"
}'

Manage Syncs

OperationMethodEndpoint
List syncsGET/elt_syncs
Get sync detailsGET/elt_syncs/{id}
Update syncPOST/elt_syncs/{id}
Enable syncPOST/elt_syncs/{id}/enable
Disable syncPOST/elt_syncs/{id}/disable
Get sync statusGET/elt_syncs/{id}/status
Delete syncDELETE/elt_syncs/{id}

Manage Streams

OperationMethodEndpoint
List available streamsGET/elt_syncs/{id}/available_source_streams
Add streamsPOST/elt_syncs/{id}/source_streams
Trigger stream runPOST/elt_streams/{id}/request_run
Request full refreshPOST/elt_streams/{id}/request_full_refresh

Was this page helpful?