--- title: /v2/events/helplineClick slug: v2eventshelplineclick docTags: createdAt: 2026-05-28T20:42:36.152Z --- { "id": "Zf9SPl97uXm3VZAzoCnK4", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.throughlinecare.com/v2/events/helplineClick", "description": "Record a helpline click event.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "HelplineClick", "type": "object", "description": "Record a helpline click event.", "customType": "HelplineClick", "schema": [ { "name": "helplineId", "kind": "required", "type": "string", "description": "ID of the helpline" }, { "name": "sessionId", "kind": "required", "type": "string", "description": "

Client-generated session identifier

" }, { "name": "timestamp", "kind": "required", "type": "string", "description": "ISO 8601 timestamp" }, { "name": "contactMethod", "kind": "required", "type": "string", "description": "

Contact method used. Supported values are \"phone\", \"sms\", \"onlineChat\", \"website\", \"tty\", \"whatsapp\", and \"reportingForm\".

", "enum": [ "phone", "sms", "online_chat", "website", "tty", "whatsapp", "reporting_form" ] } ], "modelRef": "#/definitions/HelplineClick", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "bearerAuth", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Enter the token with the \"Bearer: \" prefix e.g. \"Bearer ABC...\"

", "in": "header" } ] }, "responses": [ { "statusCode": "201", "description": "Event recorded successfully.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Event recorded successfully.", "customType": "HelplineClick", "schema": [ { "name": "helplineId", "kind": "required", "type": "string", "description": "ID of the helpline" }, { "name": "sessionId", "kind": "required", "type": "string", "description": "

Client-generated session identifier

" }, { "name": "timestamp", "kind": "required", "type": "string", "description": "ISO 8601 timestamp" }, { "name": "contactMethod", "kind": "required", "type": "string", "description": "

Contact method used. Supported values are \"phone\", \"sms\", \"onlineChat\", \"website\", \"tty\", \"whatsapp\", and \"reportingForm\".

", "enum": [ "phone", "sms", "online_chat", "website", "tty", "whatsapp", "reporting_form" ] } ], "modelRef": "#/definitions/HelplineClick", "isExpanded": true } ] }, { "statusCode": "400", "description": "Missing or invalid required fields", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Missing or invalid required fields", "customType": "HelplineClick", "schema": [ { "name": "helplineId", "kind": "required", "type": "string", "description": "ID of the helpline" }, { "name": "sessionId", "kind": "required", "type": "string", "description": "

Client-generated session identifier

" }, { "name": "timestamp", "kind": "required", "type": "string", "description": "ISO 8601 timestamp" }, { "name": "contactMethod", "kind": "required", "type": "string", "description": "

Contact method used. Supported values are \"phone\", \"sms\", \"onlineChat\", \"website\", \"tty\", \"whatsapp\", and \"reportingForm\".

", "enum": [ "phone", "sms", "online_chat", "website", "tty", "whatsapp", "reporting_form" ] } ], "modelRef": "#/definitions/HelplineClick", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Unauthorized", "customType": "HelplineClick", "schema": [ { "name": "helplineId", "kind": "required", "type": "string", "description": "ID of the helpline" }, { "name": "sessionId", "kind": "required", "type": "string", "description": "

Client-generated session identifier

" }, { "name": "timestamp", "kind": "required", "type": "string", "description": "ISO 8601 timestamp" }, { "name": "contactMethod", "kind": "required", "type": "string", "description": "

Contact method used. Supported values are \"phone\", \"sms\", \"onlineChat\", \"website\", \"tty\", \"whatsapp\", and \"reportingForm\".

", "enum": [ "phone", "sms", "online_chat", "website", "tty", "whatsapp", "reporting_form" ] } ], "modelRef": "#/definitions/HelplineClick", "isExpanded": true } ] }, { "statusCode": "422", "description": "Invalid helpline", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Invalid helpline", "customType": "HelplineClick", "schema": [ { "name": "helplineId", "kind": "required", "type": "string", "description": "ID of the helpline" }, { "name": "sessionId", "kind": "required", "type": "string", "description": "

Client-generated session identifier

" }, { "name": "timestamp", "kind": "required", "type": "string", "description": "ISO 8601 timestamp" }, { "name": "contactMethod", "kind": "required", "type": "string", "description": "

Contact method used. Supported values are \"phone\", \"sms\", \"onlineChat\", \"website\", \"tty\", \"whatsapp\", and \"reportingForm\".

", "enum": [ "phone", "sms", "online_chat", "website", "tty", "whatsapp", "reporting_form" ] } ], "modelRef": "#/definitions/HelplineClick", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "cATu-UqWz1KRftz2x3_qy", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"helplineId\": \"\",\n \"sessionId\": \"\",\n \"timestamp\": \"\",\n \"contactMethod\": \"\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.throughlinecare.com/v2/events/helplineClick\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "GWpCkpxK6CO321Yi_Ohtc", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.throughlinecare.com/v2/events/helplineClick\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"helplineId\": \"\",\n \"sessionId\": \"\",\n \"timestamp\": \"\",\n \"contactMethod\": \"\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "1D78aR36sgKdzV-Ov3FFz", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.throughlinecare.com/v2/events/helplineClick\"\n\npayload = json.dumps({\n \"helplineId\": \"\",\n \"sessionId\": \"\",\n \"timestamp\": \"\",\n \"contactMethod\": \"\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "id": "ZuQGIJXjPV1oReZ4WudjX", "language": "java", "label": "Java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"helplineId\\\": \\\"\\\",\\n \\\"sessionId\\\": \\\"\\\",\\n \\\"timestamp\\\": \\\"\\\",\\n \\\"contactMethod\\\": \\\"\\\"\\n}\");\nRequest request = new Request.Builder()\n .url(\"https://api.throughlinecare.com/v2/events/helplineClick\")\n .method(\"POST\", body)\n .addHeader(\"accept\", \"application/json\")\n .addHeader(\"content-type\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" }, { "id": "TLB1jOOoR8Ad6EjZhSLXK", "language": "swift", "label": "Swift", "code": "let parameters = \"{\\n \\\"helplineId\\\": \\\"\\\",\\n \\\"sessionId\\\": \\\"\\\",\\n \\\"timestamp\\\": \\\"\\\",\\n \\\"contactMethod\\\": \\\"\\\"\\n}\"\nlet postData = parameters.data(using: .utf8)\n\nvar request = URLRequest(url: URL(string: \"https://api.throughlinecare.com/v2/events/helplineClick\")!,timeoutInterval: Double.infinity)\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"accept\")\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"content-type\")\n\nrequest.httpMethod = \"POST\"\nrequest.httpBody = postData\n\nlet task = URLSession.shared.dataTask(with: request) { data, response, error in \n guard let data = data else {\n print(String(describing: error))\n return\n }\n print(String(data: data, encoding: .utf8)!)\n}\n\ntask.resume()\n" } ], "selectedLanguageId": "cATu-UqWz1KRftz2x3_qy" }, "results": { "languages": [ { "id": "U8k5_fjaw5_WYxLWn_HrF", "language": "201", "code": "// Event recorded successfully.\n{\n \"helplineId\": \"\",\n \"sessionId\": \"\",\n \"timestamp\": \"\",\n \"contactMethod\": \"\"\n}" }, { "id": "cLtg73fpT_2jrXuL5mbZZ", "language": "400", "code": "// Missing or invalid required fields\n{\n \"helplineId\": \"\",\n \"sessionId\": \"\",\n \"timestamp\": \"\",\n \"contactMethod\": \"\"\n}" }, { "id": "20SkS2WB4wv-HSFHLF0A4", "language": "401", "code": "// Unauthorized\n{\n \"helplineId\": \"\",\n \"sessionId\": \"\",\n \"timestamp\": \"\",\n \"contactMethod\": \"\"\n}" }, { "id": "_Btaq9H_qwO8eub25AO8v", "language": "422", "code": "// Invalid helpline\n{\n \"helplineId\": \"\",\n \"sessionId\": \"\",\n \"timestamp\": \"\",\n \"contactMethod\": \"\"\n}" } ], "selectedLanguageId": "U8k5_fjaw5_WYxLWn_HrF" } }, "children": [ { "text": "" } ] }