Sync
Create a new sync
- Documentation
- Contact Us
- Introduction
Link Token
Sync
Destination
Source
Object
Connection
Customer Data
Overview
API Reference
Sync
Create a new sync
POST
/
sync
X-API-KEY
string
*
X-API-KEY
Required
string
object
*
display_name
string
*
display_name
Required
string
Add Example Value
source_id
integer
*
source_id
Required
integer
Add Example Value
destination_id
integer
*
destination_id
Required
integer
Add Example Value
object_id
integer
*
object_id
Required
integer
Add Example Value
end_customer_id
string
*
end_customer_id
Required
string
Add Example Value
namespace
string
namespace
string
Add Example Value
table_name
string
table_name
string
Add Example Value
custom_join
string
custom_join
string
Add Example Value
cursor_field
string
cursor_field
string
Add Example Value
primary_key
string
primary_key
string
Add Example Value
frequency
integer
frequency
integer
Add Example Value
frequency_units
enum<string>
frequency_units
enum<string>
Add Example Value
field_mappings
array
*
field_mappings
Required
array
Add Example Value
curl --request POST \
--url https://api.fabra.io/sync \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"display_name": "Event Sync",
"source_id": 1,
"destination_id": 2,
"object_id": 3,
"end_customer_id": "abc123",
"namespace": "end_customer_bigquery_dataset",
"table_name": "end_customer_events",
"custom_join": "select * from events join additional_properties on events.id = additional_properties.event_id;",
"cursor_field": "updated_at",
"primary_key": "event_id",
"frequency": 30,
"frequency_units": "minutes",
"field_mappings": [
{
"source_field_name": "event_name",
"destination_field_name": "event"
}
]
}'
{
"sync": {
"id": 10,
"display_name": "Event Sync",
"end_customer_id": "abc123",
"source_id": 1,
"destination_id": 2,
"object_id": 3,
"namespace": "end_customer_bigquery_dataset",
"table_name": "end_customer_events",
"custom_join": "select * from events join additional_properties on events.id = additional_properties.event_id;",
"cursor_field": "updated_at",
"primary_key": "event_id",
"frequency": 123,
"frequency_units": "minutes",
"field_mappings": [
{
"source_field_name": "event_name",
"destination_field_name": "event"
}
]
}
}
Authorizations
X-API-KEY
string
headerrequiredBody
application/json
display_name
string
requiredsource_id
integer
requireddestination_id
integer
requiredobject_id
integer
requiredend_customer_id
string
requirednamespace
string
table_name
string
custom_join
string
cursor_field
string
primary_key
string
frequency
integer
frequency_units
enum<string>
Available options:
minutes
, hours
, days
, weeks
field_mappings
object[]
requiredfield_mappings.source_field_name
string
field_mappings.destination_field_name
string
Response
200 - application/json
sync
object
sync.id
integer
sync.display_name
string
sync.end_customer_id
string
sync.source_id
integer
sync.destination_id
integer
sync.object_id
integer
sync.namespace
string
sync.table_name
string
sync.custom_join
string
sync.cursor_field
string
sync.primary_key
string
sync.frequency
integer
sync.frequency_units
enum<string>
Available options:
minutes
, hours
, days
, weeks
sync.field_mappings
object[]
sync.field_mappings.source_field_name
string
sync.field_mappings.destination_field_name
string
curl --request POST \
--url https://api.fabra.io/sync \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"display_name": "Event Sync",
"source_id": 1,
"destination_id": 2,
"object_id": 3,
"end_customer_id": "abc123",
"namespace": "end_customer_bigquery_dataset",
"table_name": "end_customer_events",
"custom_join": "select * from events join additional_properties on events.id = additional_properties.event_id;",
"cursor_field": "updated_at",
"primary_key": "event_id",
"frequency": 30,
"frequency_units": "minutes",
"field_mappings": [
{
"source_field_name": "event_name",
"destination_field_name": "event"
}
]
}'
{
"sync": {
"id": 10,
"display_name": "Event Sync",
"end_customer_id": "abc123",
"source_id": 1,
"destination_id": 2,
"object_id": 3,
"namespace": "end_customer_bigquery_dataset",
"table_name": "end_customer_events",
"custom_join": "select * from events join additional_properties on events.id = additional_properties.event_id;",
"cursor_field": "updated_at",
"primary_key": "event_id",
"frequency": 123,
"frequency_units": "minutes",
"field_mappings": [
{
"source_field_name": "event_name",
"destination_field_name": "event"
}
]
}
}