Ingest typed first-party events

curl --request POST \
  --url https://api.adapter.com/v1/custom-connectors/{connector_id}/ingest/typed \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "kind": "email",
      "external_id": "ext-123",
      "timestamp": "2023-11-07T05:31:56Z",
      "payload": {},
      "metadata": {
        "batch": "2026-06-01",
        "env": "staging"
      }
    }
  ],
  "force": false
}
'

import requests

url = "https://api.adapter.com/v1/custom-connectors/{connector_id}/ingest/typed"

payload = {
    "items": [
        {
            "kind": "email",
            "external_id": "ext-123",
            "timestamp": "2023-11-07T05:31:56Z",
            "payload": {},
            "metadata": {
                "batch": "2026-06-01",
                "env": "staging"
            }
        }
    ],
    "force": False
}
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({
    items: [
      {
        kind: 'email',
        external_id: 'ext-123',
        timestamp: '2023-11-07T05:31:56Z',
        payload: {},
        metadata: {batch: '2026-06-01', env: 'staging'}
      }
    ],
    force: false
  })
};

fetch('https://api.adapter.com/v1/custom-connectors/{connector_id}/ingest/typed', 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.adapter.com/v1/custom-connectors/{connector_id}/ingest/typed",
  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([
    'items' => [
        [
                'kind' => 'email',
                'external_id' => 'ext-123',
                'timestamp' => '2023-11-07T05:31:56Z',
                'payload' => [
                                
                ],
                'metadata' => [
                                'batch' => '2026-06-01',
                                'env' => 'staging'
                ]
        ]
    ],
    'force' => false
  ]),
  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.adapter.com/v1/custom-connectors/{connector_id}/ingest/typed"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"kind\": \"email\",\n      \"external_id\": \"ext-123\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"payload\": {},\n      \"metadata\": {\n        \"batch\": \"2026-06-01\",\n        \"env\": \"staging\"\n      }\n    }\n  ],\n  \"force\": false\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.adapter.com/v1/custom-connectors/{connector_id}/ingest/typed")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"kind\": \"email\",\n      \"external_id\": \"ext-123\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"payload\": {},\n      \"metadata\": {\n        \"batch\": \"2026-06-01\",\n        \"env\": \"staging\"\n      }\n    }\n  ],\n  \"force\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.adapter.com/v1/custom-connectors/{connector_id}/ingest/typed")

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  \"items\": [\n    {\n      \"kind\": \"email\",\n      \"external_id\": \"ext-123\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"payload\": {},\n      \"metadata\": {\n        \"batch\": \"2026-06-01\",\n        \"env\": \"staging\"\n      }\n    }\n  ],\n  \"force\": false\n}"

response = http.request(request)
puts response.read_body

{
  "status": "accepted",
  "events": 1,
  "external_ids": [
    "ext-123"
  ],
  "rejected": [
    {
      "external_id": "ext-123",
      "resource": "storage",
      "reason": "quota_exceeded"
    }
  ],
  "unchanged": [
    "<string>"
  ]
}

{
  "error_code": "quota_exceeded",
  "message": "Ingest rejected: this workspace is over its plan quota.",
  "details": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Ingestion

Ingest typed first-party events

Ingest typed first-party events (email, calendar, conversation_message, page, issue, …) from a custom connector. Use conversation_message for chat messages and message exports (iMessage, WhatsApp, assistant conversations, …); its payload is validated against the conversation_message evidence schema. message is deprecated: it is Slack-shaped and stores your data as Slack messages. Connector- and per-item metadata are merged and attached to each event under event.metadata (item wins on key conflict).

POST

custom-connectors

{connector_id}

ingest

typed

Ingest typed first-party events

curl --request POST \
  --url https://api.adapter.com/v1/custom-connectors/{connector_id}/ingest/typed \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "kind": "email",
      "external_id": "ext-123",
      "timestamp": "2023-11-07T05:31:56Z",
      "payload": {},
      "metadata": {
        "batch": "2026-06-01",
        "env": "staging"
      }
    }
  ],
  "force": false
}
'

import requests

url = "https://api.adapter.com/v1/custom-connectors/{connector_id}/ingest/typed"

payload = {
    "items": [
        {
            "kind": "email",
            "external_id": "ext-123",
            "timestamp": "2023-11-07T05:31:56Z",
            "payload": {},
            "metadata": {
                "batch": "2026-06-01",
                "env": "staging"
            }
        }
    ],
    "force": False
}
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({
    items: [
      {
        kind: 'email',
        external_id: 'ext-123',
        timestamp: '2023-11-07T05:31:56Z',
        payload: {},
        metadata: {batch: '2026-06-01', env: 'staging'}
      }
    ],
    force: false
  })
};

fetch('https://api.adapter.com/v1/custom-connectors/{connector_id}/ingest/typed', 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.adapter.com/v1/custom-connectors/{connector_id}/ingest/typed",
  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([
    'items' => [
        [
                'kind' => 'email',
                'external_id' => 'ext-123',
                'timestamp' => '2023-11-07T05:31:56Z',
                'payload' => [
                                
                ],
                'metadata' => [
                                'batch' => '2026-06-01',
                                'env' => 'staging'
                ]
        ]
    ],
    'force' => false
  ]),
  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.adapter.com/v1/custom-connectors/{connector_id}/ingest/typed"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"kind\": \"email\",\n      \"external_id\": \"ext-123\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"payload\": {},\n      \"metadata\": {\n        \"batch\": \"2026-06-01\",\n        \"env\": \"staging\"\n      }\n    }\n  ],\n  \"force\": false\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.adapter.com/v1/custom-connectors/{connector_id}/ingest/typed")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"kind\": \"email\",\n      \"external_id\": \"ext-123\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"payload\": {},\n      \"metadata\": {\n        \"batch\": \"2026-06-01\",\n        \"env\": \"staging\"\n      }\n    }\n  ],\n  \"force\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.adapter.com/v1/custom-connectors/{connector_id}/ingest/typed")

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  \"items\": [\n    {\n      \"kind\": \"email\",\n      \"external_id\": \"ext-123\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"payload\": {},\n      \"metadata\": {\n        \"batch\": \"2026-06-01\",\n        \"env\": \"staging\"\n      }\n    }\n  ],\n  \"force\": false\n}"

response = http.request(request)
puts response.read_body

{
  "status": "accepted",
  "events": 1,
  "external_ids": [
    "ext-123"
  ],
  "rejected": [
    {
      "external_id": "ext-123",
      "resource": "storage",
      "reason": "quota_exceeded"
    }
  ],
  "unchanged": [
    "<string>"
  ]
}

{
  "error_code": "quota_exceeded",
  "message": "Ingest rejected: this workspace is over its plan quota.",
  "details": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Pass your pk_live_... API key as a Bearer token.

Path Parameters

connector_id

string

required

Body

application/json

items

TypedIngestItem · object[]

required

Events to ingest, at most 500 per request. Chunk larger loads into multiple requests.

Required array length: 1 - 500 elements

Show child attributes

force

boolean

default:false

Re-process items even when their content is byte-identical to what was previously ingested for the same external_id. Without this, unchanged re-pushes are acknowledged but skipped (reported in unchanged).

Response

Successful Response

status

string

required

Always 'accepted' (a fully-rejected ingest returns 402).

Example:

"accepted"

events

integer

required

Number of events accepted.

Example:

1

external_ids

string[]

external_id of each accepted event, in submission order. Useful for callers that want to look up the resulting canonical doc.

Example:

["ext-123"]

rejected

RejectedItem · object[]

Items refused at admission on a partial-accept (some over a tier quota). Empty on full accept; a fully-rejected ingest returns 402 instead.

Show child attributes

unchanged

string[]

external_id of each accepted item whose content was byte-identical to the previously ingested version and was therefore not re-processed. Pass force=true to override.

Overview

Connectors

Custom Connectors

Ingestion

Knowledge

Triggers

Ingest typed first-party events

Authorizations

Path Parameters

Body

Response