Events
Ingest Events
Ingest batch of events.
Scopes: events:write
POST
/
v1
/
events
/
ingest
Go (SDK)
package main
import(
"context"
"os"
polargo "github.com/polarsource/polar-go"
"github.com/polarsource/polar-go/models/components"
"log"
)
func main() {
ctx := context.Background()
s := polargo.New(
polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
)
res, err := s.Events.Ingest(ctx, components.EventsIngest{
Events: []components.Events{},
})
if err != nil {
log.Fatal(err)
}
if res.EventsIngestResponse != nil {
// handle response
}
}from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
res = polar.events.ingest(request={
"events": [],
})
# Handle response
print(res)import { Polar } from "@polar-sh/sdk";
const polar = new Polar({
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});
async function run() {
const result = await polar.events.ingest({
events: [],
});
console.log(result);
}
run();declare(strict_types=1);
require 'vendor/autoload.php';
use Polar;
use Polar\Models\Components;
$sdk = Polar\Polar::builder()
->setSecurity(
'<YOUR_BEARER_TOKEN_HERE>'
)
->build();
$request = new Components\EventsIngest(
events: [],
);
$response = $sdk->events->ingest(
request: $request
);
if ($response->eventsIngestResponse !== null) {
// handle response
}curl --request POST \
--url https://api.polar.sh/v1/events/ingest \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"events": [
{
"name": "<string>",
"customer_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
"external_id": "<string>",
"parent_id": "<string>",
"metadata": {},
"member_id": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
events: [
{
name: '<string>',
customer_id: '<string>',
timestamp: '2023-11-07T05:31:56Z',
organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
external_id: '<string>',
parent_id: '<string>',
metadata: {},
member_id: '<string>'
}
]
})
};
fetch('https://api.polar.sh/v1/events/ingest', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.polar.sh/v1/events/ingest")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"events\": [\n {\n \"name\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"external_id\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"metadata\": {},\n \"member_id\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.polar.sh/v1/events/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 \"events\": [\n {\n \"name\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"external_id\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"metadata\": {},\n \"member_id\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"inserted": 123,
"duplicates": 0
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
You can generate an Organization Access Token from your organization's settings.
Body
application/json
List of events to ingest.
- EventCreateCustomer
- EventCreateExternalCustomer
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Go (SDK)
package main
import(
"context"
"os"
polargo "github.com/polarsource/polar-go"
"github.com/polarsource/polar-go/models/components"
"log"
)
func main() {
ctx := context.Background()
s := polargo.New(
polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
)
res, err := s.Events.Ingest(ctx, components.EventsIngest{
Events: []components.Events{},
})
if err != nil {
log.Fatal(err)
}
if res.EventsIngestResponse != nil {
// handle response
}
}from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
res = polar.events.ingest(request={
"events": [],
})
# Handle response
print(res)import { Polar } from "@polar-sh/sdk";
const polar = new Polar({
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});
async function run() {
const result = await polar.events.ingest({
events: [],
});
console.log(result);
}
run();declare(strict_types=1);
require 'vendor/autoload.php';
use Polar;
use Polar\Models\Components;
$sdk = Polar\Polar::builder()
->setSecurity(
'<YOUR_BEARER_TOKEN_HERE>'
)
->build();
$request = new Components\EventsIngest(
events: [],
);
$response = $sdk->events->ingest(
request: $request
);
if ($response->eventsIngestResponse !== null) {
// handle response
}curl --request POST \
--url https://api.polar.sh/v1/events/ingest \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"events": [
{
"name": "<string>",
"customer_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
"external_id": "<string>",
"parent_id": "<string>",
"metadata": {},
"member_id": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
events: [
{
name: '<string>',
customer_id: '<string>',
timestamp: '2023-11-07T05:31:56Z',
organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
external_id: '<string>',
parent_id: '<string>',
metadata: {},
member_id: '<string>'
}
]
})
};
fetch('https://api.polar.sh/v1/events/ingest', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.polar.sh/v1/events/ingest")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"events\": [\n {\n \"name\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"external_id\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"metadata\": {},\n \"member_id\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.polar.sh/v1/events/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 \"events\": [\n {\n \"name\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"external_id\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"metadata\": {},\n \"member_id\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"inserted": 123,
"duplicates": 0
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}
