V 1 Webhooks Data New

Webhook

V 1 Webhooks Data New

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_NEW
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_NEW
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
payload objectrequired
Payloads for the DATA_NEW event only include new data. For missing/incomplete data, the keys will be absent from the payload. This means that the payload shape could change for the same model between events.
anyOf
• accounting-entities
• address-types
• amenities
• ap-codes
• ap-codes-to-construction-job
• applicant-pets
• applicants
• applicants-to-applications
• applicants-to-events
• applicants-to-rentable-items
• application-statuses
• applications
• call-logs
• charge-code-types
• charge-code-types-to-charge-timings
• charge-codes
• charge-timings
• concessions
• construction-job-details
• construction-jobs
• contract-details
• contracts
• crm-agents
• crm-amenities
• crm-attributions
• crm-communities
• crm-communities-to-agents
• crm-communities-to-attributions
• crm-events
• crm-listings
• crm-pet-policies
• crm-prospects
• deposit-summaries
• deposits
• employees
• entrata-lease-periods
• entrata-unit-types
• entrata-vendor-locations
• event-results
• event-results-to-event-types
• event-sub-types
• event-types
• events
• fees
• file-types
• financial-accounts
• floor-plans
• integration-configuration-meta-data
• inventory-items
• invoice-items
• invoices
• lead-pets
• lead-relationships
• lead-sources
• leads
• leads-to-events
• leads-to-rentable-items
• lease-services
• lease-transfers
• leases
• listings
• locations
• note-categories
• owners
• owners-to-properties
• payable-register-items
• payable-registers
• pet-types
• properties
• property-lists
• property-lists-to-properties
• property-office-hours
• purchase-order-items
• purchase-order-items-to-invoices
• purchase-orders
• recurring-resident-charges
• rentable-item-assignments
• rentable-items
• rentvine-application-templates
• resident-allocations
• resident-charges
• resident-insurance
• resident-payments
• resident-pets
• resident-vehicles
• residents
• residents-to-events
• residents-to-leases
• residents-to-rentable-items
• screenings
• service-request-access-contacts
• service-request-categories
• service-request-locations
• service-request-notes
• service-request-priorities
• service-request-problems
• service-request-statuses
• service-request-vendor-categories
• service-request-vendor-contacts
• service-request-vendors
• service-request-vendors-insurance
• service-request-vendors-to-properties
• service-requests
• service-requests-to-employees
• service-requests-to-vendors
• timezones
• transactions
• unit-details
• unit-pricing
• units
• units-to-amenity
• vendor-insurance-coverage-types
• vendor-insurance-policy-types
• vendor-payment-types
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_NEW",
  "data": {
    "job_id": "string",
    "root_job_id": "string",
    "integration_id": "string",
    "job_type": "string",
    "vendor": "APPFOLIO",
    "event": "DATA_NEW",
    "record_id": "string",
    "object": "accounting-entities",
    "payload": {},
    "context": {}
  },
  "meta": {
    "object": "accounting-entities",
    "integration_id": "string"
  }
}