Data Webhooks

You will receive notifications via a webhook whenever there are new events associated with a Data or its status.

Data Synchronized

The Data Synchronized event is the quickest way for you to receive a business' accounting data when it has been extracted.

Railz sends an event on initial synchronization and every time the data is refreshed.

The payload for this event will contain all the connection information and request summary. You can identify this specific event by the property "event":"data".

{
  "data": {
    "event": "data",
    "connectionId": "CON-0a4e97aa-7a77-bbbb-00aa-b1b1001aa00",
    "businessName": "BIZ-d6b1c7d3-fe41-4447-ae72-3814b78b5142",
    "serviceName": "quickbooks",
    "requests": [
      {
        "id": "60e61e0c53031851d54b4f82",
        "request": "accounts",
        "status": "success"
      },    
      {
        "id": "6333539d6d8f1176fd9ac05b",
        "request": "balanceSheets",
        "startDate": "2018-06-01",
        "endDate": "2018-09-30",
        "reportFrequency": "year",
        "status": "success"
      },
      {
        "id": "6333539e6d8f1176fd9ac07f",
        "startDate": "2018-06-01",
        "endDate": "2018-09-30"
        "reportFrequency": "quarter",
        "status": "failed"
      },
      {
        "id": "6034449e6d8f1176fd9ac09a",
        "request": "incomeStatements",
        "startDate": "2018-04-01",
        "endDate": "2018-04-30",
        "reportFrequency": "month",
        "status": "empty"
      },
      {
        "id": "6035559e6d8f1176fd9ac0b1",
        "request": "cashflowStatements",
        "startDate": "2020-03-01",
        "endDate": "2020-03-31",
        "reportFrequency": "month",
        "status": "success"
      }
    ]
    },
    "requestId": "a3b4fc83-3e24-41aa-ba99-13cab09b0b7a"
}

📘

id refers to the request Id.

See Report Meta and Data Synchronization Status for additional information about event payload.

📘
You can consolidate all events by tracking the received connectionId or businessName and serviceName combination.