Skip to main content

V 1 Webhooks Data Update

Webhook

V 1 Webhooks Data Update

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
    DATA_UPDATE
    data objectrequired
    job_idstringrequired
    root_job_idstringrequired
    integration_idstringrequired
    job_typestringrequired
    vendorstringrequired
    Show 17 enum values
    APPFOLIOBUILDIUMELISEAIENTRATAFUNNELKNOCKMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTCAFERENTMANAGERRENTVINERESMANYARDIYARDI_REST
    eventstringrequired
    Show 1 enum value
    DATA_UPDATE
    record_idstringrequired
    objectstringrequired
    Show 114 enum values
    accounting-entitiesaddress-typesamenitiesap-codesap-codes-to-construction-jobapplicant-petsapplicantsapplicants-to-applicationsapplicants-to-eventsapplicants-to-rentable-itemsapplication-statusesapplicationscall-logscharge-code-typescharge-code-types-to-charge-timingscharge-codescharge-timingsconcessionsconstruction-job-detailsconstruction-jobscontract-detailscontractscrm-agentscrm-amenitiescrm-attributionscrm-communitiescrm-communities-to-agentscrm-communities-to-attributionscrm-eventscrm-listingscrm-pet-policiescrm-prospectsdeposit-summariesdepositsemployeesentrata-lease-periodsentrata-unit-typesentrata-vendor-locationsevent-resultsevent-results-to-event-typesevent-sub-typesevent-typeseventsfeesfile-typesfinancial-accountsfloor-plansintegration-configuration-meta-datainventory-itemsinvoice-itemsinvoiceslead-petslead-relationshipslead-sourcesleadsleads-to-eventsleads-to-rentable-itemslease-serviceslease-transfersleaseslistingslocationsnote-categoriesownersowners-to-propertiespayable-register-itemspayable-registerspet-typespropertiesproperty-listsproperty-lists-to-propertiesproperty-office-hourspurchase-order-itemspurchase-order-items-to-invoicespurchase-ordersrecurring-resident-chargesrentable-item-assignmentsrentable-itemsrentvine-application-templatesresident-allocationsresident-chargesresident-insuranceresident-paymentsresident-petsresident-vehiclesresidentsresidents-to-eventsresidents-to-leasesresidents-to-rentable-itemsscreeningsservice-request-access-contactsservice-request-categoriesservice-request-locationsservice-request-notesservice-request-prioritiesservice-request-problemsservice-request-statusesservice-request-vendor-categoriesservice-request-vendor-contactsservice-request-vendorsservice-request-vendors-insuranceservice-request-vendors-to-propertiesservice-requestsservice-requests-to-employeesservice-requests-to-vendorstimezonestransactionsunit-detailsunit-pricingunitsunits-to-amenityvendor-insurance-coverage-typesvendor-insurance-policy-typesvendor-payment-types
    diff objectrequired

    Payloads for the DATA_UPDATE event only include data that has changed. For unchanged data, the keys will be absent from the payload. This means that the payload shape could change for the same model between events.

    new objectrequired
    anyOf
    object
    previous objectrequired
    anyOf
    object
    context objectrequired
    property name*any
    meta objectrequired
    objectstringrequired
    Show 114 enum values
    accounting-entitiesaddress-typesamenitiesap-codesap-codes-to-construction-jobapplicant-petsapplicantsapplicants-to-applicationsapplicants-to-eventsapplicants-to-rentable-itemsapplication-statusesapplicationscall-logscharge-code-typescharge-code-types-to-charge-timingscharge-codescharge-timingsconcessionsconstruction-job-detailsconstruction-jobscontract-detailscontractscrm-agentscrm-amenitiescrm-attributionscrm-communitiescrm-communities-to-agentscrm-communities-to-attributionscrm-eventscrm-listingscrm-pet-policiescrm-prospectsdeposit-summariesdepositsemployeesentrata-lease-periodsentrata-unit-typesentrata-vendor-locationsevent-resultsevent-results-to-event-typesevent-sub-typesevent-typeseventsfeesfile-typesfinancial-accountsfloor-plansintegration-configuration-meta-datainventory-itemsinvoice-itemsinvoiceslead-petslead-relationshipslead-sourcesleadsleads-to-eventsleads-to-rentable-itemslease-serviceslease-transfersleaseslistingslocationsnote-categoriesownersowners-to-propertiespayable-register-itemspayable-registerspet-typespropertiesproperty-listsproperty-lists-to-propertiesproperty-office-hourspurchase-order-itemspurchase-order-items-to-invoicespurchase-ordersrecurring-resident-chargesrentable-item-assignmentsrentable-itemsrentvine-application-templatesresident-allocationsresident-chargesresident-insuranceresident-paymentsresident-petsresident-vehiclesresidentsresidents-to-eventsresidents-to-leasesresidents-to-rentable-itemsscreeningsservice-request-access-contactsservice-request-categoriesservice-request-locationsservice-request-notesservice-request-prioritiesservice-request-problemsservice-request-statusesservice-request-vendor-categoriesservice-request-vendor-contactsservice-request-vendorsservice-request-vendors-insuranceservice-request-vendors-to-propertiesservice-requestsservice-requests-to-employeesservice-requests-to-vendorstimezonestransactionsunit-detailsunit-pricingunitsunits-to-amenityvendor-insurance-coverage-typesvendor-insurance-policy-typesvendor-payment-types
    integration_idstringrequired

Response​

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

Payload
{
  "trigger": "DATA_UPDATE",
  "data": {
    "job_id": "string",
    "root_job_id": "string",
    "integration_id": "string",
    "job_type": "string",
    "vendor": "APPFOLIO",
    "event": "DATA_UPDATE",
    "record_id": "string",
    "object": "accounting-entities",
    "diff": {
      "new": {},
      "previous": {}
    },
    "context": {}
  },
  "meta": {
    "object": "accounting-entities",
    "integration_id": "string"
  }
}