Skip to main content

V 1 Webhooks First Sync Complete

Webhook

V 1 Webhooks First Sync Complete

Authentication​

  • AuthorizationBearer
    Bearer authentication of the form Bearer <token>, where token is your auth token.

Request​

This endpoint expects an object.

    triggerstringrequired
    Show 1 enum value
    FIRST_SYNC_COMPLETE
    data objectrequired
    eventstringrequired
    Show 1 enum value
    FIRST_SYNC_COMPLETE
    integration_idstringrequired
    vendorstringrequired
    Show 17 enum values
    APPFOLIOBUILDIUMELISEAIENTRATAFUNNELKNOCKMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTCAFERENTMANAGERRENTVINERESMANYARDIYARDI_REST
    is_backsyncbooleanrequired
    successful_job_countnumberrequired
    failed_job_countnumberrequired
    is_sync_finishedbooleanrequired
    job_schedule_idstring | nullnullablerequired

    The ID of the job schedule associated with the sync. This is null for manual syncs.

    models_syncedstring[]required

    Array of model names that were enabled for this sync

Response​

Return a 200 status to indicate that the webhook was received successfully

Payload
{
  "trigger": "FIRST_SYNC_COMPLETE",
  "data": {
    "event": "FIRST_SYNC_COMPLETE",
    "integration_id": "string",
    "vendor": "APPFOLIO",
    "is_backsync": true,
    "successful_job_count": 0,
    "failed_job_count": 0,
    "is_sync_finished": true,
    "job_schedule_id": "string",
    "models_synced": [
      "string"
    ]
  }
}