Ingest a public social mention into the omnichannel inbox
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/inbox/social-mentions/ingest \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"external_id": "<string>",
"permalink": "<string>",
"author_handle": "<string>",
"text": "<string>",
"author_display_name": "<string>",
"matched_keyword": "<string>",
"reach": 1,
"posted_at": "<string>",
"post_id": "<string>",
"post_permalink": "<string>",
"post_title": "<string>",
"parent_comment_id": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/inbox/social-mentions/ingest"
payload = {
"external_id": "<string>",
"permalink": "<string>",
"author_handle": "<string>",
"text": "<string>",
"author_display_name": "<string>",
"matched_keyword": "<string>",
"reach": 1,
"posted_at": "<string>",
"post_id": "<string>",
"post_permalink": "<string>",
"post_title": "<string>",
"parent_comment_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
external_id: '<string>',
permalink: '<string>',
author_handle: '<string>',
text: '<string>',
author_display_name: '<string>',
matched_keyword: '<string>',
reach: 1,
posted_at: '<string>',
post_id: '<string>',
post_permalink: '<string>',
post_title: '<string>',
parent_comment_id: '<string>'
})
};
fetch('https://api.orbit.devotel.io/api/v1/inbox/social-mentions/ingest', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/inbox/social-mentions/ingest",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_id' => '<string>',
'permalink' => '<string>',
'author_handle' => '<string>',
'text' => '<string>',
'author_display_name' => '<string>',
'matched_keyword' => '<string>',
'reach' => 1,
'posted_at' => '<string>',
'post_id' => '<string>',
'post_permalink' => '<string>',
'post_title' => '<string>',
'parent_comment_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/inbox/social-mentions/ingest"
payload := strings.NewReader("{\n \"external_id\": \"<string>\",\n \"permalink\": \"<string>\",\n \"author_handle\": \"<string>\",\n \"text\": \"<string>\",\n \"author_display_name\": \"<string>\",\n \"matched_keyword\": \"<string>\",\n \"reach\": 1,\n \"posted_at\": \"<string>\",\n \"post_id\": \"<string>\",\n \"post_permalink\": \"<string>\",\n \"post_title\": \"<string>\",\n \"parent_comment_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/inbox/social-mentions/ingest")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"external_id\": \"<string>\",\n \"permalink\": \"<string>\",\n \"author_handle\": \"<string>\",\n \"text\": \"<string>\",\n \"author_display_name\": \"<string>\",\n \"matched_keyword\": \"<string>\",\n \"reach\": 1,\n \"posted_at\": \"<string>\",\n \"post_id\": \"<string>\",\n \"post_permalink\": \"<string>\",\n \"post_title\": \"<string>\",\n \"parent_comment_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/inbox/social-mentions/ingest")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_id\": \"<string>\",\n \"permalink\": \"<string>\",\n \"author_handle\": \"<string>\",\n \"text\": \"<string>\",\n \"author_display_name\": \"<string>\",\n \"matched_keyword\": \"<string>\",\n \"reach\": 1,\n \"posted_at\": \"<string>\",\n \"post_id\": \"<string>\",\n \"post_permalink\": \"<string>\",\n \"post_title\": \"<string>\",\n \"parent_comment_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyInbox
Ingest a public social mention into the omnichannel inbox
Routes one normalised public brand mention (X/Twitter, Reddit, Trustpilot, G2, review sites) or an Instagram/Facebook post comment into the omnichannel inbox as an inbound message on a social_mention conversation. Mentions group per public author; post comments (instagram_comment / facebook_comment, which require post_id) thread per post into one replyable conversation. Idempotent on (channel, external_id) so a listening connector can safely redeliver. Owner/admin only.
POST
/
api
/
v1
/
inbox
/
social-mentions
/
ingest
Ingest a public social mention into the omnichannel inbox
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/inbox/social-mentions/ingest \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"external_id": "<string>",
"permalink": "<string>",
"author_handle": "<string>",
"text": "<string>",
"author_display_name": "<string>",
"matched_keyword": "<string>",
"reach": 1,
"posted_at": "<string>",
"post_id": "<string>",
"post_permalink": "<string>",
"post_title": "<string>",
"parent_comment_id": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/inbox/social-mentions/ingest"
payload = {
"external_id": "<string>",
"permalink": "<string>",
"author_handle": "<string>",
"text": "<string>",
"author_display_name": "<string>",
"matched_keyword": "<string>",
"reach": 1,
"posted_at": "<string>",
"post_id": "<string>",
"post_permalink": "<string>",
"post_title": "<string>",
"parent_comment_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
external_id: '<string>',
permalink: '<string>',
author_handle: '<string>',
text: '<string>',
author_display_name: '<string>',
matched_keyword: '<string>',
reach: 1,
posted_at: '<string>',
post_id: '<string>',
post_permalink: '<string>',
post_title: '<string>',
parent_comment_id: '<string>'
})
};
fetch('https://api.orbit.devotel.io/api/v1/inbox/social-mentions/ingest', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/inbox/social-mentions/ingest",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_id' => '<string>',
'permalink' => '<string>',
'author_handle' => '<string>',
'text' => '<string>',
'author_display_name' => '<string>',
'matched_keyword' => '<string>',
'reach' => 1,
'posted_at' => '<string>',
'post_id' => '<string>',
'post_permalink' => '<string>',
'post_title' => '<string>',
'parent_comment_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/inbox/social-mentions/ingest"
payload := strings.NewReader("{\n \"external_id\": \"<string>\",\n \"permalink\": \"<string>\",\n \"author_handle\": \"<string>\",\n \"text\": \"<string>\",\n \"author_display_name\": \"<string>\",\n \"matched_keyword\": \"<string>\",\n \"reach\": 1,\n \"posted_at\": \"<string>\",\n \"post_id\": \"<string>\",\n \"post_permalink\": \"<string>\",\n \"post_title\": \"<string>\",\n \"parent_comment_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/inbox/social-mentions/ingest")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"external_id\": \"<string>\",\n \"permalink\": \"<string>\",\n \"author_handle\": \"<string>\",\n \"text\": \"<string>\",\n \"author_display_name\": \"<string>\",\n \"matched_keyword\": \"<string>\",\n \"reach\": 1,\n \"posted_at\": \"<string>\",\n \"post_id\": \"<string>\",\n \"post_permalink\": \"<string>\",\n \"post_title\": \"<string>\",\n \"parent_comment_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/inbox/social-mentions/ingest")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_id\": \"<string>\",\n \"permalink\": \"<string>\",\n \"author_handle\": \"<string>\",\n \"text\": \"<string>\",\n \"author_display_name\": \"<string>\",\n \"matched_keyword\": \"<string>\",\n \"reach\": 1,\n \"posted_at\": \"<string>\",\n \"post_id\": \"<string>\",\n \"post_permalink\": \"<string>\",\n \"post_title\": \"<string>\",\n \"parent_comment_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Available options:
twitter, reddit, trustpilot, g2, google_reviews, facebook_public, facebook_comment, instagram_comment, youtube, app_store, play_store, news, forum, other Provider's stable mention id — the idempotency key (channel, external_id).
http(s) link to the public mention.
Available options:
positive, neutral, negative Required range:
x >= 0ISO-8601 timestamp the mention was posted.
Parent-post id — REQUIRED for instagram_comment / facebook_comment.
Response
Default Response
⌘I