Bulk import events
curl --request POST \
--url https://app.octavehq.com/api/v2/event/import \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"events": [
{
"eventTimestamp": "<string>",
"subject": "<string>",
"body": {
"text": "<string>",
"html": "<string>"
},
"from": {
"email": "jsmith@example.com",
"name": "<string>"
},
"to": [
{
"email": "jsmith@example.com",
"name": "<string>"
}
],
"type": "email",
"cc": [
{
"email": "jsmith@example.com",
"name": "<string>"
}
],
"bcc": [
{
"email": "jsmith@example.com",
"name": "<string>"
}
],
"eventId": "<string>",
"conversationId": "<string>",
"campaignId": "<string>",
"octaveRequestId": "<string>",
"sourceProviderName": "<string>",
"customMetadata": {}
}
],
"callbackUrl": "<string>"
}
'import requests
url = "https://app.octavehq.com/api/v2/event/import"
payload = {
"events": [
{
"eventTimestamp": "<string>",
"subject": "<string>",
"body": {
"text": "<string>",
"html": "<string>"
},
"from": {
"email": "jsmith@example.com",
"name": "<string>"
},
"to": [
{
"email": "jsmith@example.com",
"name": "<string>"
}
],
"type": "email",
"cc": [
{
"email": "jsmith@example.com",
"name": "<string>"
}
],
"bcc": [
{
"email": "jsmith@example.com",
"name": "<string>"
}
],
"eventId": "<string>",
"conversationId": "<string>",
"campaignId": "<string>",
"octaveRequestId": "<string>",
"sourceProviderName": "<string>",
"customMetadata": {}
}
],
"callbackUrl": "<string>"
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
events: [
{
eventTimestamp: '<string>',
subject: '<string>',
body: JSON.stringify({text: '<string>', html: '<string>'}),
from: {email: 'jsmith@example.com', name: '<string>'},
to: [{email: 'jsmith@example.com', name: '<string>'}],
type: 'email',
cc: [{email: 'jsmith@example.com', name: '<string>'}],
bcc: [{email: 'jsmith@example.com', name: '<string>'}],
eventId: '<string>',
conversationId: '<string>',
campaignId: '<string>',
octaveRequestId: '<string>',
sourceProviderName: '<string>',
customMetadata: {}
}
],
callbackUrl: '<string>'
})
};
fetch('https://app.octavehq.com/api/v2/event/import', 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://app.octavehq.com/api/v2/event/import",
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([
'events' => [
[
'eventTimestamp' => '<string>',
'subject' => '<string>',
'body' => [
'text' => '<string>',
'html' => '<string>'
],
'from' => [
'email' => 'jsmith@example.com',
'name' => '<string>'
],
'to' => [
[
'email' => 'jsmith@example.com',
'name' => '<string>'
]
],
'type' => 'email',
'cc' => [
[
'email' => 'jsmith@example.com',
'name' => '<string>'
]
],
'bcc' => [
[
'email' => 'jsmith@example.com',
'name' => '<string>'
]
],
'eventId' => '<string>',
'conversationId' => '<string>',
'campaignId' => '<string>',
'octaveRequestId' => '<string>',
'sourceProviderName' => '<string>',
'customMetadata' => [
]
]
],
'callbackUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$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://app.octavehq.com/api/v2/event/import"
payload := strings.NewReader("{\n \"events\": [\n {\n \"eventTimestamp\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\"\n },\n \"from\": {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n },\n \"to\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"type\": \"email\",\n \"cc\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"eventId\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"octaveRequestId\": \"<string>\",\n \"sourceProviderName\": \"<string>\",\n \"customMetadata\": {}\n }\n ],\n \"callbackUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
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://app.octavehq.com/api/v2/event/import")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"events\": [\n {\n \"eventTimestamp\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\"\n },\n \"from\": {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n },\n \"to\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"type\": \"email\",\n \"cc\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"eventId\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"octaveRequestId\": \"<string>\",\n \"sourceProviderName\": \"<string>\",\n \"customMetadata\": {}\n }\n ],\n \"callbackUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/event/import")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"events\": [\n {\n \"eventTimestamp\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\"\n },\n \"from\": {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n },\n \"to\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"type\": \"email\",\n \"cc\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"eventId\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"octaveRequestId\": \"<string>\",\n \"sourceProviderName\": \"<string>\",\n \"customMetadata\": {}\n }\n ],\n \"callbackUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"jobs": [
{
"provider": "OCTAVE_GENERIC_CALL",
"jobOId": "pbj_3rgkoHhR00cEdE9DjKeIK",
"accepted": 123,
"preSkipped": 123,
"duplicatesInBatch": [
123
]
}
],
"totalAccepted": 123,
"totalPreSkipped": 123
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Events
Bulk import events
Imports a batch of events (calls, emails, CRM, social) into the analytics pipeline. Accepts up to 1000 events per request; events are ingested asynchronously.
One import job is created per event type present in the request; each job is tracked independently via GET /event/import/status.
Deduplication: supply eventId on each event for predictable dedupe, otherwise a deterministic ID is derived from the event’s content. Events whose ID matches an existing event in the workspace are skipped (reported as preSkipped); duplicate IDs within one request keep the first occurrence (later indices reported in duplicatesInBatch).
Skipped vs failed: only processable event types produce analytics events (email sent/reply, call transcript, all CRM types, all social types) — other event types are accepted but land in the job’s skipped count, alongside duplicates and internal-only events. ingested is the authoritative success count.
Callback: if callbackUrl is provided, each job POSTs its final counts to that URL once on completion (one callback per job; delivery is best-effort — poll the status endpoint as the source of truth).
POST
/
api
/
v2
/
event
/
import
Bulk import events
curl --request POST \
--url https://app.octavehq.com/api/v2/event/import \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"events": [
{
"eventTimestamp": "<string>",
"subject": "<string>",
"body": {
"text": "<string>",
"html": "<string>"
},
"from": {
"email": "jsmith@example.com",
"name": "<string>"
},
"to": [
{
"email": "jsmith@example.com",
"name": "<string>"
}
],
"type": "email",
"cc": [
{
"email": "jsmith@example.com",
"name": "<string>"
}
],
"bcc": [
{
"email": "jsmith@example.com",
"name": "<string>"
}
],
"eventId": "<string>",
"conversationId": "<string>",
"campaignId": "<string>",
"octaveRequestId": "<string>",
"sourceProviderName": "<string>",
"customMetadata": {}
}
],
"callbackUrl": "<string>"
}
'import requests
url = "https://app.octavehq.com/api/v2/event/import"
payload = {
"events": [
{
"eventTimestamp": "<string>",
"subject": "<string>",
"body": {
"text": "<string>",
"html": "<string>"
},
"from": {
"email": "jsmith@example.com",
"name": "<string>"
},
"to": [
{
"email": "jsmith@example.com",
"name": "<string>"
}
],
"type": "email",
"cc": [
{
"email": "jsmith@example.com",
"name": "<string>"
}
],
"bcc": [
{
"email": "jsmith@example.com",
"name": "<string>"
}
],
"eventId": "<string>",
"conversationId": "<string>",
"campaignId": "<string>",
"octaveRequestId": "<string>",
"sourceProviderName": "<string>",
"customMetadata": {}
}
],
"callbackUrl": "<string>"
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
events: [
{
eventTimestamp: '<string>',
subject: '<string>',
body: JSON.stringify({text: '<string>', html: '<string>'}),
from: {email: 'jsmith@example.com', name: '<string>'},
to: [{email: 'jsmith@example.com', name: '<string>'}],
type: 'email',
cc: [{email: 'jsmith@example.com', name: '<string>'}],
bcc: [{email: 'jsmith@example.com', name: '<string>'}],
eventId: '<string>',
conversationId: '<string>',
campaignId: '<string>',
octaveRequestId: '<string>',
sourceProviderName: '<string>',
customMetadata: {}
}
],
callbackUrl: '<string>'
})
};
fetch('https://app.octavehq.com/api/v2/event/import', 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://app.octavehq.com/api/v2/event/import",
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([
'events' => [
[
'eventTimestamp' => '<string>',
'subject' => '<string>',
'body' => [
'text' => '<string>',
'html' => '<string>'
],
'from' => [
'email' => 'jsmith@example.com',
'name' => '<string>'
],
'to' => [
[
'email' => 'jsmith@example.com',
'name' => '<string>'
]
],
'type' => 'email',
'cc' => [
[
'email' => 'jsmith@example.com',
'name' => '<string>'
]
],
'bcc' => [
[
'email' => 'jsmith@example.com',
'name' => '<string>'
]
],
'eventId' => '<string>',
'conversationId' => '<string>',
'campaignId' => '<string>',
'octaveRequestId' => '<string>',
'sourceProviderName' => '<string>',
'customMetadata' => [
]
]
],
'callbackUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$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://app.octavehq.com/api/v2/event/import"
payload := strings.NewReader("{\n \"events\": [\n {\n \"eventTimestamp\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\"\n },\n \"from\": {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n },\n \"to\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"type\": \"email\",\n \"cc\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"eventId\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"octaveRequestId\": \"<string>\",\n \"sourceProviderName\": \"<string>\",\n \"customMetadata\": {}\n }\n ],\n \"callbackUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
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://app.octavehq.com/api/v2/event/import")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"events\": [\n {\n \"eventTimestamp\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\"\n },\n \"from\": {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n },\n \"to\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"type\": \"email\",\n \"cc\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"eventId\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"octaveRequestId\": \"<string>\",\n \"sourceProviderName\": \"<string>\",\n \"customMetadata\": {}\n }\n ],\n \"callbackUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/event/import")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"events\": [\n {\n \"eventTimestamp\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\"\n },\n \"from\": {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n },\n \"to\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"type\": \"email\",\n \"cc\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\"\n }\n ],\n \"eventId\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"octaveRequestId\": \"<string>\",\n \"sourceProviderName\": \"<string>\",\n \"customMetadata\": {}\n }\n ],\n \"callbackUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"jobs": [
{
"provider": "OCTAVE_GENERIC_CALL",
"jobOId": "pbj_3rgkoHhR00cEdE9DjKeIK",
"accepted": 123,
"preSkipped": 123,
"duplicatesInBatch": [
123
]
}
],
"totalAccepted": 123,
"totalPreSkipped": 123
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
Up to 1000 events per request. Each event carries a type discriminator (email | call | crm | social) and otherwise follows the corresponding generic event structure used by the single-event webhook endpoints.
Response
Import jobs created
⌘I