# Connect a tool Source: https://jointextkit.com/docs/api/integrations/connect Index: https://jointextkit.com/llms.txt `POST /v1/integrations` Connects a tool with its API key or service account, the same as the console's Integrations page: the credentials are proved with one read, then sealed and never returned. Its people sync into a list of their own every 6 hours (and on POST /v1/integrations/{id}/sync). Consent comes across only from the field or opt-in event you name. A push integration (provider webhook, or Mixpanel / Amplitude with mode "push") answers ingest_url and ingest_token once. Scope: contacts. Send your API key as a bearer token: `Authorization: Bearer ssms_sk_...`. Test keys run this endpoint against the [sandbox](/docs/sandbox); see [Authentication](/docs/authentication) for key modes and scopes. ## Request body JSON (`Content-Type: application/json`). | Field | Type | Required | Description | | --- | --- | --- | --- | | `provider` | `shopify`, `hubspot`, `salesforce`, `mixpanel`, `amplitude`, `webhook` | Yes | | | `mode` | `pull`, `push` | No | Mixpanel / Amplitude: pull with credentials every 6 hours (default when credentials are sent), or push: no credentials, the tool's cohort sync posts to the ingest URL. | | `name` | string | No | What to call it (default: the tool and its source). | | `sourceId` | string | No | Mixpanel or Amplitude cohort id; HubSpot list id; Salesforce campaign id; a Shopify customer search. Blank = everyone (HubSpot, Shopify, Salesforce). | | `projectId` | string | No | Mixpanel project id. | | `region` | `us`, `eu` | No | Mixpanel / Amplitude data residency. | | `username` | string | No | Mixpanel service account username. | | `secret` | string | No | Mixpanel service account secret. | | `apiKey` | string | No | Amplitude API key. | | `secretKey` | string | No | Amplitude secret key. | | `accessToken` | string | No | HubSpot private app token, or Shopify Admin API access token. | | `shopDomain` | string | No | Shopify store, like acme.myshopify.com. | | `instanceUrl` | string | No | Salesforce My Domain URL. | | `sfObject` | `Contact`, `Lead` | No | | | `clientId` | string | No | Salesforce consumer key, or Shopify client id. | | `clientSecret` | string | No | Salesforce consumer secret, or Shopify client secret. | | `phoneField` | string | No | The tool's property holding the mobile number, when not the usual one ($phone, phone, mobilephone). | | `consentField` | string | No | The tool's property that records SMS consent (e.g. sms_opt_in). | | `consentEvent` | string | No | Mixpanel / Amplitude: the opt-in event the cohort is built on (e.g. SMS Opt In). Everyone in the cohort is recorded as opted in, from that event. | | `phoneEvent` | string | No | Mixpanel: an event that carries the number when profiles do not (e.g. Verification Check Success). A member with no phone on the profile gets it from their latest such event. | | `phoneEventProperty` | string | No | Mixpanel: that event's property holding the number (default phone). | ## Responses | Status | Meaning | Body | | --- | --- | --- | | 201 | The integration (with ingest_url and ingest_token once, for push) | JSON object | | 401 | Missing, malformed, or revoked API key | `Error` | | 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | `Error` | | 429 | Rate limit or quota exceeded | `Error` | ## Errors | Status | When | | --- | --- | | 401 | Missing, malformed, or revoked API key | | 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | | 429 | Rate limit or quota exceeded | Every error has the same JSON shape, and `request_id` matches the `X-Request-Id` response header. [Errors](/docs/errors) lists every code and what to do about it. ```json { "error": { "code": "invalid_request", "message": "What went wrong, in plain words.", "param": "the_field", "request_id": "req_a1B2c3D4e5F6g7H8" } } ``` ## Examples ### Node.js The Node.js SDK does not wrap this endpoint yet; call it over HTTP. ```javascript const res = await fetch('https://api.jointextkit.com/v1/integrations', { method: 'POST', headers: { Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ "provider": "shopify" }), }); if (!res.ok) throw new Error((await res.json()).error.message); const data = await res.json(); ``` ### PHP ```php 'POST', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ' . getenv('TEXTKIT_API_KEY'), 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => json_encode([ 'provider' => 'shopify', ]), ]); $data = json_decode(curl_exec($ch), true); ``` ### Python The Python SDK does not wrap this endpoint yet; call it over HTTP. ```python import json, os, urllib.request req = urllib.request.Request( "https://api.jointextkit.com/v1/integrations", method="POST", headers={ "Authorization": f"Bearer {os.environ['TEXTKIT_API_KEY']}", "Content-Type": "application/json", }, data=json.dumps({ "provider": "shopify" }).encode(), ) with urllib.request.urlopen(req) as res: data = json.load(res) ``` ### Ruby ```ruby require "net/http" require "json" uri = URI("https://api.jointextkit.com/v1/integrations") req = Net::HTTP::Post.new(uri) req["Authorization"] = "Bearer #{ENV["TEXTKIT_API_KEY"]}" req["Content-Type"] = "application/json" req.body = { "provider": "shopify" }.to_json res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) } data = JSON.parse(res.body) ``` ### Go ```go package main import ( "fmt" "io" "net/http" "os" "strings" ) func main() { body := strings.NewReader(`{ "provider": "shopify" }`) req, _ := http.NewRequest("POST", "https://api.jointextkit.com/v1/integrations", body) req.Header.Set("Authorization", "Bearer "+os.Getenv("TEXTKIT_API_KEY")) req.Header.Set("Content-Type", "application/json") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(res.Status, string(data)) } ``` ### Rust ```rust // cargo add reqwest --features blocking,json // cargo add serde_json use serde_json::json; fn main() -> Result<(), Box> { let key = std::env::var("TEXTKIT_API_KEY")?; let res = reqwest::blocking::Client::new() .post("https://api.jointextkit.com/v1/integrations") .bearer_auth(key) .json(&json!({ "provider": "shopify" })) .send()? .error_for_status()?; let data: serde_json::Value = res.json()?; println!("{data}"); Ok(()) } ``` ### Java ```java import java.net.URI; import java.net.http.*; public class Main { public static void main(String[] args) throws Exception { var request = HttpRequest.newBuilder(URI.create("https://api.jointextkit.com/v1/integrations")) .header("Authorization", "Bearer " + System.getenv("TEXTKIT_API_KEY")) .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(""" { "provider": "shopify" } """)) .build(); var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.statusCode() + " " + response.body()); } } ``` ### .NET ```csharp using System.Net.Http.Headers; using System.Text; var http = new HttpClient(); http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue( "Bearer", Environment.GetEnvironmentVariable("TEXTKIT_API_KEY")); var body = new StringContent(""" { "provider": "shopify" } """, Encoding.UTF8, "application/json"); var res = await http.PostAsync("https://api.jointextkit.com/v1/integrations", body); res.EnsureSuccessStatusCode(); var data = await res.Content.ReadAsStringAsync(); ``` ### cURL ```bash curl -X POST "https://api.jointextkit.com/v1/integrations" \ -H "Authorization: Bearer $TEXTKIT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "provider": "shopify" }' ``` ## Related - [All integrations endpoints](/docs/api#integrations) - [API reference](/docs/api)