Apply Side Effects to Directly Loaded Records
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/imports/{import}/jobs/{job}/side-effects \
--header 'Content-Type: application/json' \
--data '
{
"fire_events": true,
"schedule_notifications": true
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/imports/{import}/jobs/{job}/side-effects"
payload = {
"fire_events": True,
"schedule_notifications": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({fire_events: true, schedule_notifications: true})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/imports/{import}/jobs/{job}/side-effects', 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.{tenant}.getomneo.com/api/v3/imports/{import}/jobs/{job}/side-effects",
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([
'fire_events' => true,
'schedule_notifications' => true
]),
CURLOPT_HTTPHEADER => [
"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.{tenant}.getomneo.com/api/v3/imports/{import}/jobs/{job}/side-effects"
payload := strings.NewReader("{\n \"fire_events\": true,\n \"schedule_notifications\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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.{tenant}.getomneo.com/api/v3/imports/{import}/jobs/{job}/side-effects")
.header("Content-Type", "application/json")
.body("{\n \"fire_events\": true,\n \"schedule_notifications\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/imports/{import}/jobs/{job}/side-effects")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"fire_events\": true,\n \"schedule_notifications\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"batch_count": 123,
"row_count": 123
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Import Job
Apply Side Effects to Directly Loaded Records
A POST to the /imports/{importId}/jobs/{jobId}/side-effects endpoint queues what creating the rewards or benefits through the API would have done, for every row a direct database load wrote for this import (source_type import, source_id the import’s id): ledger entries, issue/remind/extend notifications and, with fire_events, the *.created and balance.updated events.
Rows are tracked as batches of this job, so add the returned batch_count to the job’s total_batch_count when finalizing it. Rows already queued by an earlier call are skipped.
POST
/
v3
/
imports
/
{import}
/
jobs
/
{job}
/
side-effects
Apply Side Effects to Directly Loaded Records
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/imports/{import}/jobs/{job}/side-effects \
--header 'Content-Type: application/json' \
--data '
{
"fire_events": true,
"schedule_notifications": true
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/imports/{import}/jobs/{job}/side-effects"
payload = {
"fire_events": True,
"schedule_notifications": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({fire_events: true, schedule_notifications: true})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/imports/{import}/jobs/{job}/side-effects', 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.{tenant}.getomneo.com/api/v3/imports/{import}/jobs/{job}/side-effects",
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([
'fire_events' => true,
'schedule_notifications' => true
]),
CURLOPT_HTTPHEADER => [
"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.{tenant}.getomneo.com/api/v3/imports/{import}/jobs/{job}/side-effects"
payload := strings.NewReader("{\n \"fire_events\": true,\n \"schedule_notifications\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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.{tenant}.getomneo.com/api/v3/imports/{import}/jobs/{job}/side-effects")
.header("Content-Type", "application/json")
.body("{\n \"fire_events\": true,\n \"schedule_notifications\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/imports/{import}/jobs/{job}/side-effects")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"fire_events\": true,\n \"schedule_notifications\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"batch_count": 123,
"row_count": 123
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}