Import custom events
curl --request POST \
--url https://{notifuseDomain}/api/customEvents.import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workspace_id": "ws_1234567890",
"events": [
{
"event_name": "orders/fulfilled",
"external_id": "shopify_order_12345",
"email": "customer@example.com",
"properties": {
"order_total": 129.99,
"product_name": "Premium Subscription"
},
"occurred_at": "2023-05-15T14:30:00Z"
},
{
"event_name": "payment/succeeded",
"external_id": "stripe_payment_67890",
"email": "customer@example.com",
"properties": {
"amount": 129.99,
"currency": "USD"
},
"occurred_at": "2023-05-15T14:29:00Z"
}
]
}
'import requests
url = "https://{notifuseDomain}/api/customEvents.import"
payload = {
"workspace_id": "ws_1234567890",
"events": [
{
"event_name": "orders/fulfilled",
"external_id": "shopify_order_12345",
"email": "customer@example.com",
"properties": {
"order_total": 129.99,
"product_name": "Premium Subscription"
},
"occurred_at": "2023-05-15T14:30:00Z"
},
{
"event_name": "payment/succeeded",
"external_id": "stripe_payment_67890",
"email": "customer@example.com",
"properties": {
"amount": 129.99,
"currency": "USD"
},
"occurred_at": "2023-05-15T14:29:00Z"
}
]
}
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({
workspace_id: 'ws_1234567890',
events: [
{
event_name: 'orders/fulfilled',
external_id: 'shopify_order_12345',
email: 'customer@example.com',
properties: {order_total: 129.99, product_name: 'Premium Subscription'},
occurred_at: '2023-05-15T14:30:00Z'
},
{
event_name: 'payment/succeeded',
external_id: 'stripe_payment_67890',
email: 'customer@example.com',
properties: {amount: 129.99, currency: 'USD'},
occurred_at: '2023-05-15T14:29:00Z'
}
]
})
};
fetch('https://{notifuseDomain}/api/customEvents.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://{notifuseDomain}/api/customEvents.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([
'workspace_id' => 'ws_1234567890',
'events' => [
[
'event_name' => 'orders/fulfilled',
'external_id' => 'shopify_order_12345',
'email' => 'customer@example.com',
'properties' => [
'order_total' => 129.99,
'product_name' => 'Premium Subscription'
],
'occurred_at' => '2023-05-15T14:30:00Z'
],
[
'event_name' => 'payment/succeeded',
'external_id' => 'stripe_payment_67890',
'email' => 'customer@example.com',
'properties' => [
'amount' => 129.99,
'currency' => 'USD'
],
'occurred_at' => '2023-05-15T14:29:00Z'
]
]
]),
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://{notifuseDomain}/api/customEvents.import"
payload := strings.NewReader("{\n \"workspace_id\": \"ws_1234567890\",\n \"events\": [\n {\n \"event_name\": \"orders/fulfilled\",\n \"external_id\": \"shopify_order_12345\",\n \"email\": \"customer@example.com\",\n \"properties\": {\n \"order_total\": 129.99,\n \"product_name\": \"Premium Subscription\"\n },\n \"occurred_at\": \"2023-05-15T14:30:00Z\"\n },\n {\n \"event_name\": \"payment/succeeded\",\n \"external_id\": \"stripe_payment_67890\",\n \"email\": \"customer@example.com\",\n \"properties\": {\n \"amount\": 129.99,\n \"currency\": \"USD\"\n },\n \"occurred_at\": \"2023-05-15T14:29:00Z\"\n }\n ]\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://{notifuseDomain}/api/customEvents.import")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspace_id\": \"ws_1234567890\",\n \"events\": [\n {\n \"event_name\": \"orders/fulfilled\",\n \"external_id\": \"shopify_order_12345\",\n \"email\": \"customer@example.com\",\n \"properties\": {\n \"order_total\": 129.99,\n \"product_name\": \"Premium Subscription\"\n },\n \"occurred_at\": \"2023-05-15T14:30:00Z\"\n },\n {\n \"event_name\": \"payment/succeeded\",\n \"external_id\": \"stripe_payment_67890\",\n \"email\": \"customer@example.com\",\n \"properties\": {\n \"amount\": 129.99,\n \"currency\": \"USD\"\n },\n \"occurred_at\": \"2023-05-15T14:29:00Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{notifuseDomain}/api/customEvents.import")
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 \"workspace_id\": \"ws_1234567890\",\n \"events\": [\n {\n \"event_name\": \"orders/fulfilled\",\n \"external_id\": \"shopify_order_12345\",\n \"email\": \"customer@example.com\",\n \"properties\": {\n \"order_total\": 129.99,\n \"product_name\": \"Premium Subscription\"\n },\n \"occurred_at\": \"2023-05-15T14:30:00Z\"\n },\n {\n \"event_name\": \"payment/succeeded\",\n \"external_id\": \"stripe_payment_67890\",\n \"email\": \"customer@example.com\",\n \"properties\": {\n \"amount\": 129.99,\n \"currency\": \"USD\"\n },\n \"occurred_at\": \"2023-05-15T14:29:00Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"event_ids": [
"shopify_order_12345",
"stripe_payment_67890"
],
"count": 2
}Custom Events
Import custom events
Imports multiple custom events in a single batch operation. Maximum 50 events per request. Auto-creates contacts if they don’t exist.
POST
/
api
/
customEvents.import
Import custom events
curl --request POST \
--url https://{notifuseDomain}/api/customEvents.import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workspace_id": "ws_1234567890",
"events": [
{
"event_name": "orders/fulfilled",
"external_id": "shopify_order_12345",
"email": "customer@example.com",
"properties": {
"order_total": 129.99,
"product_name": "Premium Subscription"
},
"occurred_at": "2023-05-15T14:30:00Z"
},
{
"event_name": "payment/succeeded",
"external_id": "stripe_payment_67890",
"email": "customer@example.com",
"properties": {
"amount": 129.99,
"currency": "USD"
},
"occurred_at": "2023-05-15T14:29:00Z"
}
]
}
'import requests
url = "https://{notifuseDomain}/api/customEvents.import"
payload = {
"workspace_id": "ws_1234567890",
"events": [
{
"event_name": "orders/fulfilled",
"external_id": "shopify_order_12345",
"email": "customer@example.com",
"properties": {
"order_total": 129.99,
"product_name": "Premium Subscription"
},
"occurred_at": "2023-05-15T14:30:00Z"
},
{
"event_name": "payment/succeeded",
"external_id": "stripe_payment_67890",
"email": "customer@example.com",
"properties": {
"amount": 129.99,
"currency": "USD"
},
"occurred_at": "2023-05-15T14:29:00Z"
}
]
}
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({
workspace_id: 'ws_1234567890',
events: [
{
event_name: 'orders/fulfilled',
external_id: 'shopify_order_12345',
email: 'customer@example.com',
properties: {order_total: 129.99, product_name: 'Premium Subscription'},
occurred_at: '2023-05-15T14:30:00Z'
},
{
event_name: 'payment/succeeded',
external_id: 'stripe_payment_67890',
email: 'customer@example.com',
properties: {amount: 129.99, currency: 'USD'},
occurred_at: '2023-05-15T14:29:00Z'
}
]
})
};
fetch('https://{notifuseDomain}/api/customEvents.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://{notifuseDomain}/api/customEvents.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([
'workspace_id' => 'ws_1234567890',
'events' => [
[
'event_name' => 'orders/fulfilled',
'external_id' => 'shopify_order_12345',
'email' => 'customer@example.com',
'properties' => [
'order_total' => 129.99,
'product_name' => 'Premium Subscription'
],
'occurred_at' => '2023-05-15T14:30:00Z'
],
[
'event_name' => 'payment/succeeded',
'external_id' => 'stripe_payment_67890',
'email' => 'customer@example.com',
'properties' => [
'amount' => 129.99,
'currency' => 'USD'
],
'occurred_at' => '2023-05-15T14:29:00Z'
]
]
]),
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://{notifuseDomain}/api/customEvents.import"
payload := strings.NewReader("{\n \"workspace_id\": \"ws_1234567890\",\n \"events\": [\n {\n \"event_name\": \"orders/fulfilled\",\n \"external_id\": \"shopify_order_12345\",\n \"email\": \"customer@example.com\",\n \"properties\": {\n \"order_total\": 129.99,\n \"product_name\": \"Premium Subscription\"\n },\n \"occurred_at\": \"2023-05-15T14:30:00Z\"\n },\n {\n \"event_name\": \"payment/succeeded\",\n \"external_id\": \"stripe_payment_67890\",\n \"email\": \"customer@example.com\",\n \"properties\": {\n \"amount\": 129.99,\n \"currency\": \"USD\"\n },\n \"occurred_at\": \"2023-05-15T14:29:00Z\"\n }\n ]\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://{notifuseDomain}/api/customEvents.import")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspace_id\": \"ws_1234567890\",\n \"events\": [\n {\n \"event_name\": \"orders/fulfilled\",\n \"external_id\": \"shopify_order_12345\",\n \"email\": \"customer@example.com\",\n \"properties\": {\n \"order_total\": 129.99,\n \"product_name\": \"Premium Subscription\"\n },\n \"occurred_at\": \"2023-05-15T14:30:00Z\"\n },\n {\n \"event_name\": \"payment/succeeded\",\n \"external_id\": \"stripe_payment_67890\",\n \"email\": \"customer@example.com\",\n \"properties\": {\n \"amount\": 129.99,\n \"currency\": \"USD\"\n },\n \"occurred_at\": \"2023-05-15T14:29:00Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{notifuseDomain}/api/customEvents.import")
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 \"workspace_id\": \"ws_1234567890\",\n \"events\": [\n {\n \"event_name\": \"orders/fulfilled\",\n \"external_id\": \"shopify_order_12345\",\n \"email\": \"customer@example.com\",\n \"properties\": {\n \"order_total\": 129.99,\n \"product_name\": \"Premium Subscription\"\n },\n \"occurred_at\": \"2023-05-15T14:30:00Z\"\n },\n {\n \"event_name\": \"payment/succeeded\",\n \"external_id\": \"stripe_payment_67890\",\n \"email\": \"customer@example.com\",\n \"properties\": {\n \"amount\": 129.99,\n \"currency\": \"USD\"\n },\n \"occurred_at\": \"2023-05-15T14:29:00Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"event_ids": [
"shopify_order_12345",
"stripe_payment_67890"
],
"count": 2
}Authorizations
API token for authentication
Body
application/json
The ID of the workspace
Example:
"ws_1234567890"
Array of custom events to import (1-50 events)
Required array length:
1 - 50 elementsShow child attributes
Show child attributes
Example:
[
{
"event_name": "orders/fulfilled",
"external_id": "shopify_order_12345",
"email": "customer@example.com",
"properties": {
"order_total": 129.99,
"product_name": "Premium Subscription"
},
"occurred_at": "2023-05-15T14:30:00Z"
},
{
"event_name": "payment/succeeded",
"external_id": "stripe_payment_67890",
"email": "customer@example.com",
"properties": { "amount": 129.99, "currency": "USD" },
"occurred_at": "2023-05-15T14:29:00Z"
}
]
⌘I
