Sync
Create a new sync
POST
/
sync
Authorization
Body
curl --request POST \
--url https://api.fabra.io/sync \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <x-api-key>' \
--data '{
"cursor_field": "updated_at",
"custom_join": "select * from events join additional_properties on events.id = additional_properties.event_id;",
"destination_id": 2,
"display_name": "Event Sync",
"end_customer_id": "abc123",
"field_mappings": [
{
"destination_field_name": "event",
"source_field_name": "event_name"
}
],
"frequency": 30,
"frequency_units": "minutes",
"namespace": "end_customer_bigquery_dataset",
"object_id": 3,
"primary_key": "event_id",
"source_id": 1,
"table_name": "end_customer_events"
}'
{
"sync": {
"cursor_field": "updated_at",
"custom_join": "select * from events join additional_properties on events.id = additional_properties.event_id;",
"destination_id": 2,
"display_name": "Event Sync",
"end_customer_id": "abc123",
"field_mappings": [
{
"destination_field_name": "event",
"source_field_name": "event_name"
}
],
"frequency": 123,
"frequency_units": "minutes",
"id": 10,
"namespace": "end_customer_bigquery_dataset",
"object_id": 3,
"primary_key": "event_id",
"source_id": 1,
"table_name": "end_customer_events"
}
}
Authorizations
X-API-KEY
string
headerrequiredBody
application/json
cursor_field
string
custom_join
string
destination_id
integer
requireddisplay_name
string
requiredend_customer_id
string
requiredfield_mappings
object[]
requiredfrequency
integer
frequency_units
enum<string>
Available options:
minutes
, hours
, days
, weeks
namespace
string
object_id
integer
requiredprimary_key
string
source_id
integer
requiredtable_name
string
Response
200 - application/json
sync
object
curl --request POST \
--url https://api.fabra.io/sync \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <x-api-key>' \
--data '{
"cursor_field": "updated_at",
"custom_join": "select * from events join additional_properties on events.id = additional_properties.event_id;",
"destination_id": 2,
"display_name": "Event Sync",
"end_customer_id": "abc123",
"field_mappings": [
{
"destination_field_name": "event",
"source_field_name": "event_name"
}
],
"frequency": 30,
"frequency_units": "minutes",
"namespace": "end_customer_bigquery_dataset",
"object_id": 3,
"primary_key": "event_id",
"source_id": 1,
"table_name": "end_customer_events"
}'
{
"sync": {
"cursor_field": "updated_at",
"custom_join": "select * from events join additional_properties on events.id = additional_properties.event_id;",
"destination_id": 2,
"display_name": "Event Sync",
"end_customer_id": "abc123",
"field_mappings": [
{
"destination_field_name": "event",
"source_field_name": "event_name"
}
],
"frequency": 123,
"frequency_units": "minutes",
"id": 10,
"namespace": "end_customer_bigquery_dataset",
"object_id": 3,
"primary_key": "event_id",
"source_id": 1,
"table_name": "end_customer_events"
}
}