Ingest a normalized business signal
curl --request POST \
--url https://salespilot.crossup.ai/v1/connections/{connection_id}/ingest-signals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"signal_id": "<string>",
"signal_type": "<string>",
"occurred_at": "2023-11-07T05:31:56Z",
"provider": "<string>",
"external_resource_id": "<string>",
"payload": "<unknown>",
"source_version": "<string>",
"provider_event_id": "<string>"
}
'import requests
url = "https://salespilot.crossup.ai/v1/connections/{connection_id}/ingest-signals"
payload = {
"signal_id": "<string>",
"signal_type": "<string>",
"occurred_at": "2023-11-07T05:31:56Z",
"provider": "<string>",
"external_resource_id": "<string>",
"payload": "<unknown>",
"source_version": "<string>",
"provider_event_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({
signal_id: '<string>',
signal_type: '<string>',
occurred_at: '2023-11-07T05:31:56Z',
provider: '<string>',
external_resource_id: '<string>',
payload: '<unknown>',
source_version: '<string>',
provider_event_id: '<string>'
})
};
fetch('https://salespilot.crossup.ai/v1/connections/{connection_id}/ingest-signals', 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://salespilot.crossup.ai/v1/connections/{connection_id}/ingest-signals",
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([
'signal_id' => '<string>',
'signal_type' => '<string>',
'occurred_at' => '2023-11-07T05:31:56Z',
'provider' => '<string>',
'external_resource_id' => '<string>',
'payload' => '<unknown>',
'source_version' => '<string>',
'provider_event_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://salespilot.crossup.ai/v1/connections/{connection_id}/ingest-signals"
payload := strings.NewReader("{\n \"signal_id\": \"<string>\",\n \"signal_type\": \"<string>\",\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"provider\": \"<string>\",\n \"external_resource_id\": \"<string>\",\n \"payload\": \"<unknown>\",\n \"source_version\": \"<string>\",\n \"provider_event_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://salespilot.crossup.ai/v1/connections/{connection_id}/ingest-signals")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"signal_id\": \"<string>\",\n \"signal_type\": \"<string>\",\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"provider\": \"<string>\",\n \"external_resource_id\": \"<string>\",\n \"payload\": \"<unknown>\",\n \"source_version\": \"<string>\",\n \"provider_event_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://salespilot.crossup.ai/v1/connections/{connection_id}/ingest-signals")
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 \"signal_id\": \"<string>\",\n \"signal_type\": \"<string>\",\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"provider\": \"<string>\",\n \"external_resource_id\": \"<string>\",\n \"payload\": \"<unknown>\",\n \"source_version\": \"<string>\",\n \"provider_event_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"signal_id": "<string>",
"status": "accepted"
}{
"type": "https://api.crossup.ai/salespilot/errors/invalid-request",
"title": "Invalid request",
"status": 400,
"detail": "<string>",
"code": "invalid_request",
"request_id": "<string>",
"errors": [
{
"code": "<string>",
"detail": "<string>",
"pointer": "<string>"
}
]
}{
"type": "https://api.crossup.ai/salespilot/errors/unauthorized",
"title": "Authentication required",
"status": 401,
"detail": "<string>",
"code": "unauthorized",
"request_id": "<string>"
}{
"type": "https://api.crossup.ai/salespilot/errors/forbidden-connection",
"title": "Connection is not accessible",
"status": 403,
"detail": "<string>",
"code": "forbidden_connection",
"request_id": "<string>"
}{
"type": "https://api.crossup.ai/salespilot/errors/conflict",
"title": "Request conflicts with current state",
"status": 409,
"detail": "<string>",
"code": "conflict",
"request_id": "<string>"
}{
"type": "https://api.crossup.ai/salespilot/errors/rate-limited",
"title": "Too many requests",
"status": 429,
"detail": "<string>",
"code": "rate_limited",
"request_id": "<string>"
}{
"type": "https://api.crossup.ai/salespilot/errors/internal-error",
"title": "Internal server error",
"status": 500,
"detail": "<string>",
"code": "internal_error",
"request_id": "<string>"
}Operations
Ingest a catalog event
Receives an already normalized catalog event and deduplicates it by signal_id.
POST
/
v1
/
connections
/
{connection_id}
/
ingest-signals
Ingest a normalized business signal
curl --request POST \
--url https://salespilot.crossup.ai/v1/connections/{connection_id}/ingest-signals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"signal_id": "<string>",
"signal_type": "<string>",
"occurred_at": "2023-11-07T05:31:56Z",
"provider": "<string>",
"external_resource_id": "<string>",
"payload": "<unknown>",
"source_version": "<string>",
"provider_event_id": "<string>"
}
'import requests
url = "https://salespilot.crossup.ai/v1/connections/{connection_id}/ingest-signals"
payload = {
"signal_id": "<string>",
"signal_type": "<string>",
"occurred_at": "2023-11-07T05:31:56Z",
"provider": "<string>",
"external_resource_id": "<string>",
"payload": "<unknown>",
"source_version": "<string>",
"provider_event_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({
signal_id: '<string>',
signal_type: '<string>',
occurred_at: '2023-11-07T05:31:56Z',
provider: '<string>',
external_resource_id: '<string>',
payload: '<unknown>',
source_version: '<string>',
provider_event_id: '<string>'
})
};
fetch('https://salespilot.crossup.ai/v1/connections/{connection_id}/ingest-signals', 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://salespilot.crossup.ai/v1/connections/{connection_id}/ingest-signals",
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([
'signal_id' => '<string>',
'signal_type' => '<string>',
'occurred_at' => '2023-11-07T05:31:56Z',
'provider' => '<string>',
'external_resource_id' => '<string>',
'payload' => '<unknown>',
'source_version' => '<string>',
'provider_event_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://salespilot.crossup.ai/v1/connections/{connection_id}/ingest-signals"
payload := strings.NewReader("{\n \"signal_id\": \"<string>\",\n \"signal_type\": \"<string>\",\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"provider\": \"<string>\",\n \"external_resource_id\": \"<string>\",\n \"payload\": \"<unknown>\",\n \"source_version\": \"<string>\",\n \"provider_event_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://salespilot.crossup.ai/v1/connections/{connection_id}/ingest-signals")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"signal_id\": \"<string>\",\n \"signal_type\": \"<string>\",\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"provider\": \"<string>\",\n \"external_resource_id\": \"<string>\",\n \"payload\": \"<unknown>\",\n \"source_version\": \"<string>\",\n \"provider_event_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://salespilot.crossup.ai/v1/connections/{connection_id}/ingest-signals")
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 \"signal_id\": \"<string>\",\n \"signal_type\": \"<string>\",\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"provider\": \"<string>\",\n \"external_resource_id\": \"<string>\",\n \"payload\": \"<unknown>\",\n \"source_version\": \"<string>\",\n \"provider_event_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"signal_id": "<string>",
"status": "accepted"
}{
"type": "https://api.crossup.ai/salespilot/errors/invalid-request",
"title": "Invalid request",
"status": 400,
"detail": "<string>",
"code": "invalid_request",
"request_id": "<string>",
"errors": [
{
"code": "<string>",
"detail": "<string>",
"pointer": "<string>"
}
]
}{
"type": "https://api.crossup.ai/salespilot/errors/unauthorized",
"title": "Authentication required",
"status": 401,
"detail": "<string>",
"code": "unauthorized",
"request_id": "<string>"
}{
"type": "https://api.crossup.ai/salespilot/errors/forbidden-connection",
"title": "Connection is not accessible",
"status": 403,
"detail": "<string>",
"code": "forbidden_connection",
"request_id": "<string>"
}{
"type": "https://api.crossup.ai/salespilot/errors/conflict",
"title": "Request conflicts with current state",
"status": 409,
"detail": "<string>",
"code": "conflict",
"request_id": "<string>"
}{
"type": "https://api.crossup.ai/salespilot/errors/rate-limited",
"title": "Too many requests",
"status": 429,
"detail": "<string>",
"code": "rate_limited",
"request_id": "<string>"
}{
"type": "https://api.crossup.ai/salespilot/errors/internal-error",
"title": "Internal server error",
"status": 500,
"detail": "<string>",
"code": "internal_error",
"request_id": "<string>"
}The connection travels in the path, not in the body, and is checked against
the token’s store. A The client derives the
connection_id from another store returns
forbidden_connection.
The client derives the signal_id
signal_id is required in the body. The server recomputes and checks it,
but doesn’t make it up for you. The derivation is deterministic:
material = provider | connection_id | signal_type | external_resource_id | deliveryID
deliveryID = provider_event_id, and if empty: hex(sha256(canonicalJSON(payload)))
signal_id = "sig_" + hex(sha256(material)[:8]) // 16 hex characters
provider_event_id is optional: if the provider gives no delivery id, the
key falls back to the payload’s canonical digest.
Your implementation must match the server’s byte for byte; otherwise
duplicate stops working. Canonicalization keeps each number’s literal: 10
and 10.0 are not the same payload.
Resending the same event is safe
The first time the response isstatus: "accepted"; the second,
status: "duplicate", with the same signal_id. A duplicate doesn’t touch
the catalog again, so retrying is safe.
source_version can’t go backwards. A signal with a source_version older
than the applied one returns conflict and
the catalog stays as it was.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
CrossUp connection identifier.
Minimum string length:
1Body
application/json
Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1