Init Sync

POST 
/ext/integrations/sync-sdk/init-sync

Whenever you need to synchronize data points, you must invoke this API to generate a fresh syncId for the target application. In the subsequent APIs, in addition to the data, you will need to include both the syncId and the instance ID

Request

application/json

Body

forceSync string
orgIntegrationId string

Responses

201

201 Response

application/json

Schema

Schema

message string
syncId string
syncPath string

Example (from schema)

{
  "message": "init sync started",
  "syncId": "651c22bce053f9173bc6d301",
  "syncPath": "612f89ee689585002f28d234/651b2108f8845b4222953d2f/651c2235e0eda4199c32e2dd/2023/9/3/651c22bce053f9173bc6d301"
}

201 Response

{
  "message": "init sync started",
  "syncId": "651c22bce053f9173bc6d301",
  "syncPath": "612f89ee689585002f28d234/651b2108f8845b4222953d2f/651c2235e0eda4199c32e2dd/2023/9/3/651c22bce053f9173bc6d301"
}

400

Bad request

application/json

Schema

Schema

error

object

ValidationError

object[]

Array [

location string

msg string

param string

]

status number
sentry_id string

Example (from schema)

{
  "error": {
    "ValidationError": [
      {
        "location": "body",
        "msg": "Invalid value",
        "param": "orgIntegrationId"
      }
    ],
    "status": 400
  },
  "sentry_id": "e05c07706c134af395e247f3491bbdc0"
}

Bad request

{
  "error": {
    "ValidationError": [
      {
        "location": "body",
        "msg": "Invalid value",
        "param": "orgIntegrationId"
      }
    ],
    "status": 400
  },
  "sentry_id": "e05c07706c134af395e247f3491bbdc0"
}

Loading...