Arthur Online · AsyncAPI Specification
Arthur Online Webhooks
Version 1.0.0
The Arthur Online webhook event surface. A property manager subscribes a webhook URL to one or more of the 125 published triggers on the Arthur webhook page; Arthur then POSTs a form-encoded payload to that URL each time the corresponding event fires in the entity. Derived verbatim from the provider's published trigger table in the public Arthur API Postman collection (https://developer.arthuronline.co.uk/) and the official payload templates at https://github.com/arthur-crm/webhookPayloadTemplates. Arthur publishes no AsyncAPI of its own; this document is the API Evangelist rendering of that published surface.
View Spec
View on GitHub
Real EstateUnited KingdomProperty ManagementPropTechRentalsLettingsTenancyMaintenanceProperty ListingsSocial HousingStudent HousingBlock ManagementAsyncAPIWebhooksEvents
Channels
arthurWebhook
Arthur POSTs every subscribed event to the single webhook URL registered for that event. Delivery attempts, timestamps, status and server response are recorded in the webhook logs in the Arthur UI (View logs).
Messages
accesskeyAccessKeysIndividualExpired
AccessKey: Access Keys (Individual) Expired
Arthur fires this webhook when the AccessKey event "Access Keys (Individual) Expired" occurs in the subscribed entity.
applicantApplicantAddedViaMiddleware
Applicant: Applicant added via Middleware
Arthur fires this webhook when the Applicant event "Applicant added via Middleware" occurs in the subscribed entity.
applicantApplicantAdded
Applicant: Applicant added
Arthur fires this webhook when the Applicant event "Applicant added" occurs in the subscribed entity.
applicantApplicantUpdatedViaMiddleware
Applicant: Applicant updated via Middleware
Arthur fires this webhook when the Applicant event "Applicant updated via Middleware" occurs in the subscribed entity.
assetFileSharedWithAllOccupants
Asset: File shared with all occupants
Arthur fires this webhook when the Asset event "File shared with all occupants" occurs in the subscribed entity.
assetFileUploaded
Asset: File uploaded
Arthur fires this webhook when the Asset event "File uploaded" occurs in the subscribed entity.
assetsharingpersonAssetSharing
AssetSharingPerson: Asset sharing
Arthur fires this webhook when the AssetSharingPerson event "Asset sharing" occurs in the subscribed entity.
attachmentFileAttachmentShared
Attachment: File attachment shared
Arthur fires this webhook when the Attachment event "File attachment shared" occurs in the subscribed entity.
certificateCertificateAdded
Certificate: Certificate Added
Arthur fires this webhook when the Certificate event "Certificate Added" occurs in the subscribed entity.
certificateCertificateExpiredToday
Certificate: Certificate Expired Today
Arthur fires this webhook when the Certificate event "Certificate Expired Today" occurs in the subscribed entity.
certificateCertificateExpiresIn30Days
Certificate: Certificate Expires in 30 Days
Arthur fires this webhook when the Certificate event "Certificate Expires in 30 Days" occurs in the subscribed entity.
certificateCertificateExpiresIn7Days
Certificate: Certificate Expires in 7 Days
Arthur fires this webhook when the Certificate event "Certificate Expires in 7 Days" occurs in the subscribed entity.
inventoryInventoryAdded
Inventory: Inventory added
Arthur fires this webhook when the Inventory event "Inventory added" occurs in the subscribed entity.
inventoryInventoryExpiredToday
Inventory: Inventory expired today
Arthur fires this webhook when the Inventory event "Inventory expired today" occurs in the subscribed entity.
messageEmailSent
Message: Email sent
Arthur fires this webhook when the Message event "Email sent" occurs in the subscribed entity.
noticeNoticeAdded
Notice: Notice Added
Arthur fires this webhook when the Notice event "Notice Added" occurs in the subscribed entity.
noticeNoticeExpiredToday
Notice: Notice expired today
Arthur fires this webhook when the Notice event "Notice expired today" occurs in the subscribed entity.
noticeNoticeExpiresIn30Days
Notice: Notice expires in 30 days
Arthur fires this webhook when the Notice event "Notice expires in 30 days" occurs in the subscribed entity.
noticeNoticeExpiresIn7Days
Notice: Notice expires in 7 days
Arthur fires this webhook when the Notice event "Notice expires in 7 days" occurs in the subscribed entity.
personAddContractor
Person: Add Contractor
Arthur fires this webhook when the Person event "Add Contractor" occurs in the subscribed entity.
personAddPropertyManager
Person: Add Property Manager
Arthur fires this webhook when the Person event "Add Property Manager" occurs in the subscribed entity.
personAddPropertyOwner
Person: Add Property Owner
Arthur fires this webhook when the Person event "Add Property Owner" occurs in the subscribed entity.
personInviteContractor
Person: Invite Contractor
Arthur fires this webhook when the Person event "Invite Contractor" occurs in the subscribed entity.
personInvitePropertyManager
Person: Invite Property Manager
Arthur fires this webhook when the Person event "Invite Property Manager" occurs in the subscribed entity.
personInvitePropertyOwner
Person: Invite Property Owner
Arthur fires this webhook when the Person event "Invite Property Owner" occurs in the subscribed entity.
propertyPropertyCreated
Property: Property created
Arthur fires this webhook when the Property event "Property created" occurs in the subscribed entity.
recurringRecurringEnded
Recurring: Recurring Ended
Arthur fires this webhook when the Recurring event "Recurring Ended" occurs in the subscribed entity.
reminderPropertyManagerEmail
Reminder: Property Manager Email
Arthur fires this webhook when the Reminder event "Property Manager Email" occurs in the subscribed entity.
reminderPropertyManagerNotification
Reminder: Property Manager Notification
Arthur fires this webhook when the Reminder event "Property Manager Notification" occurs in the subscribed entity.
reminderPropertyManagerSMS
Reminder: Property Manager SMS
Arthur fires this webhook when the Reminder event "Property Manager SMS" occurs in the subscribed entity.
reminderPropertyOwnerEmail
Reminder: Property Owner Email
Arthur fires this webhook when the Reminder event "Property Owner Email" occurs in the subscribed entity.
reminderPropertyOwnerNotification
Reminder: Property Owner Notification
Arthur fires this webhook when the Reminder event "Property Owner Notification" occurs in the subscribed entity.
reminderPropertyOwnerSMS
Reminder: Property Owner SMS
Arthur fires this webhook when the Reminder event "Property Owner SMS" occurs in the subscribed entity.
reminderTenantEmail
Reminder: Tenant Email
Arthur fires this webhook when the Reminder event "Tenant Email" occurs in the subscribed entity.
reminderTenantNotification
Reminder: Tenant Notification
Arthur fires this webhook when the Reminder event "Tenant Notification" occurs in the subscribed entity.
reminderTenantSMS
Reminder: Tenant SMS
Arthur fires this webhook when the Reminder event "Tenant SMS" occurs in the subscribed entity.
rentreviewRentReviewAdded
RentReview: Rent Review added
Arthur fires this webhook when the RentReview event "Rent Review added" occurs in the subscribed entity.
rentreviewRentReviewCompleted
RentReview: Rent Review completed
Arthur fires this webhook when the RentReview event "Rent Review completed" occurs in the subscribed entity.
rentreviewRentReviewDueToday
RentReview: Rent Review due today
Arthur fires this webhook when the RentReview event "Rent Review due today" occurs in the subscribed entity.
rentreviewRentReviewInProgress
RentReview: Rent Review in progress
Arthur fires this webhook when the RentReview event "Rent Review in progress" occurs in the subscribed entity.
renterInviteTenant
Renter: Invite Tenant
Arthur fires this webhook when the Renter event "Invite Tenant" occurs in the subscribed entity.
renterTenantAddedToTenancy
Renter: Tenant added to tenancy
Arthur fires this webhook when the Renter event "Tenant added to tenancy" occurs in the subscribed entity.
reportentitySharedReport
ReportEntity: Shared Report
Arthur fires this webhook when the ReportEntity event "Shared Report" occurs in the subscribed entity.
syncschedulerQuickbooksStartSync
SyncScheduler: Quickbooks Start Sync
Arthur fires this webhook when the SyncScheduler event "Quickbooks Start Sync" occurs in the subscribed entity.
syncschedulerQuickbooksSyncDone
SyncScheduler: Quickbooks Sync Done
Arthur fires this webhook when the SyncScheduler event "Quickbooks Sync Done" occurs in the subscribed entity.
syncschedulerQuickbooksSyncFailed
SyncScheduler: Quickbooks Sync Failed
Arthur fires this webhook when the SyncScheduler event "Quickbooks Sync Failed" occurs in the subscribed entity.
syncschedulerQuickbooksSyncSuccess
SyncScheduler: Quickbooks Sync Success
Arthur fires this webhook when the SyncScheduler event "Quickbooks Sync Success" occurs in the subscribed entity.
syncschedulerXeroStartSync
SyncScheduler: Xero Start Sync
Arthur fires this webhook when the SyncScheduler event "Xero Start Sync" occurs in the subscribed entity.
syncschedulerXeroSyncDone
SyncScheduler: Xero Sync Done
Arthur fires this webhook when the SyncScheduler event "Xero Sync Done" occurs in the subscribed entity.
syncschedulerXeroSyncFailed
SyncScheduler: Xero Sync Failed
Arthur fires this webhook when the SyncScheduler event "Xero Sync Failed" occurs in the subscribed entity.
syncschedulerXeroSyncSuccess
SyncScheduler: Xero Sync Success
Arthur fires this webhook when the SyncScheduler event "Xero Sync Success" occurs in the subscribed entity.
taskPropertyManagerSharedWorkorderWithTenants
Task: Property Manager shared workorder with tenants
Arthur fires this webhook when the Task event "Property Manager shared workorder with tenants" occurs in the subscribed entity.
taskTaskAdded
Task: Task added
Arthur fires this webhook when the Task event "Task added" occurs in the subscribed entity.
taskTaskCancelled
Task: Task cancelled
Arthur fires this webhook when the Task event "Task cancelled" occurs in the subscribed entity.
taskTaskSetBackToPending
Task: Task set back to pending
Arthur fires this webhook when the Task event "Task set back to pending" occurs in the subscribed entity.
taskTaskSetToCancelled
Task: Task set to cancelled
Arthur fires this webhook when the Task event "Task set to cancelled" occurs in the subscribed entity.
taskTaskSetToCompleted
Task: Task set to completed
Arthur fires this webhook when the Task event "Task set to completed" occurs in the subscribed entity.
taskTaskSetToCompleted2
Task: Task set to completed
Arthur fires this webhook when the Task event "Task set to completed" occurs in the subscribed entity.
taskTaskSetToInProgress
Task: Task set to in progress
Arthur fires this webhook when the Task event "Task set to in progress" occurs in the subscribed entity.
taskTaskSetToLive
Task: Task set to live
Arthur fires this webhook when the Task event "Task set to live" occurs in the subscribed entity.
taskTaskSetToPending
Task: Task set to pending
Arthur fires this webhook when the Task event "Task set to pending" occurs in the subscribed entity.
taskTaskUpdated
Task: Task updated
Arthur fires this webhook when the Task event "Task updated" occurs in the subscribed entity.
taskTenantRaisesAnIssue
Task: Tenant raises an issue
Arthur fires this webhook when the Task event "Tenant raises an issue" occurs in the subscribed entity.
taskTenantUpdatedIssueDescription
Task: Tenant updated issue description
Arthur fires this webhook when the Task event "Tenant updated issue description" occurs in the subscribed entity.
tenancyMovingInDateConfirmedByContractor
Tenancy: Moving in date confirmed by Contractor
Arthur fires this webhook when the Tenancy event "Moving in date confirmed by Contractor" occurs in the subscribed entity.
tenancyMovingInDateConfirmedByLettingAgent
Tenancy: Moving in date confirmed by Letting Agent
Arthur fires this webhook when the Tenancy event "Moving in date confirmed by Letting Agent" occurs in the subscribed entity.
tenancyMovingOutDateConfirmedByContractor
Tenancy: Moving out date confirmed by Contractor
Arthur fires this webhook when the Tenancy event "Moving out date confirmed by Contractor" occurs in the subscribed entity.
tenancyMovingOutDateConfirmedByLettingAgent
Tenancy: Moving out date confirmed by Letting Agent
Arthur fires this webhook when the Tenancy event "Moving out date confirmed by Letting Agent" occurs in the subscribed entity.
tenancyProspectiveTenancyAddedByLettingAgent
Tenancy: Prospective tenancy added by Letting Agent
Arthur fires this webhook when the Tenancy event "Prospective tenancy added by Letting Agent" occurs in the subscribed entity.
tenancyTenancyExpiring
Tenancy: Tenancy Expiring
Arthur fires this webhook when the Tenancy event "Tenancy Expiring" occurs in the subscribed entity.
tenancyTenancyReferenceSetToFailedByLettingAgent
Tenancy: Tenancy Reference set to Failed by Letting Agent
Arthur fires this webhook when the Tenancy event "Tenancy Reference set to Failed by Letting Agent" occurs in the subscribed entity.
tenancyTenancyReferenceSetToFailedByPropertyManager
Tenancy: Tenancy Reference set to Failed by Property Manager
Arthur fires this webhook when the Tenancy event "Tenancy Reference set to Failed by Property Manager" occurs in the subscribed entity.
tenancyTenancyReferenceSetToPassedByLettingAgent
Tenancy: Tenancy Reference set to Passed by Letting Agent
Arthur fires this webhook when the Tenancy event "Tenancy Reference set to Passed by Letting Agent" occurs in the subscribed entity.
tenancyTenancyReferenceSetToPassedByPropertyManager
Tenancy: Tenancy Reference set to Passed by Property Manager
Arthur fires this webhook when the Tenancy event "Tenancy Reference set to Passed by Property Manager" occurs in the subscribed entity.
tenancyTenancyClosing
Tenancy: Tenancy closing
Arthur fires this webhook when the Tenancy event "Tenancy closing" occurs in the subscribed entity.
tenancyTenancyStatusSetToApproved
Tenancy: Tenancy status set to approved
Arthur fires this webhook when the Tenancy event "Tenancy status set to approved" occurs in the subscribed entity.
tenancyTenancyStatusSetToCurrent
Tenancy: Tenancy status set to current
Arthur fires this webhook when the Tenancy event "Tenancy status set to current" occurs in the subscribed entity.
tenancyTenancyStatusSetToEnding
Tenancy: Tenancy status set to ending
Arthur fires this webhook when the Tenancy event "Tenancy status set to ending" occurs in the subscribed entity.
tenancyTenancyStatusSetToPast
Tenancy: Tenancy status set to past
Arthur fires this webhook when the Tenancy event "Tenancy status set to past" occurs in the subscribed entity.
tenancyTenancyStatusSetToPeriodic
Tenancy: Tenancy status set to periodic
Arthur fires this webhook when the Tenancy event "Tenancy status set to periodic" occurs in the subscribed entity.
tenancyTenancyStatusSetToProspective
Tenancy: Tenancy status set to prospective
Arthur fires this webhook when the Tenancy event "Tenancy status set to prospective" occurs in the subscribed entity.
tenancyTenancyStatusSetToRejected
Tenancy: Tenancy status set to rejected
Arthur fires this webhook when the Tenancy event "Tenancy status set to rejected" occurs in the subscribed entity.
tenancyTenancyUpdated
Tenancy: Tenancy updated
Arthur fires this webhook when the Tenancy event "Tenancy updated" occurs in the subscribed entity.
tenancyTenantRequestsEndingTenancy
Tenancy: Tenant requests ending tenancy
Arthur fires this webhook when the Tenancy event "Tenant requests ending tenancy" occurs in the subscribed entity.
tenancyTenantRequestsExtendingTenancy
Tenancy: Tenant requests extending tenancy
Arthur fires this webhook when the Tenancy event "Tenant requests extending tenancy" occurs in the subscribed entity.
tenancychangeChangeTenancy
TenancyChange: Change Tenancy
Arthur fires this webhook when the TenancyChange event "Change Tenancy" occurs in the subscribed entity.
transactionHoldingDepositReceiptAddedByPropertyManager
Transaction: Holding Deposit Receipt added by Property Manager
Arthur fires this webhook when the Transaction event "Holding Deposit Receipt added by Property Manager" occurs in the subscribed entity.
transactionLateRent14Days
Transaction: Late rent 14 days
Arthur fires this webhook when the Transaction event "Late rent 14 days" occurs in the subscribed entity.
transactionLateRent21Days
Transaction: Late rent 21 days
Arthur fires this webhook when the Transaction event "Late rent 21 days" occurs in the subscribed entity.
transactionLateRent7Days
Transaction: Late rent 7 days
Arthur fires this webhook when the Transaction event "Late rent 7 days" occurs in the subscribed entity.
transactionRemittedToPropertyOwnerSplit
Transaction: Remitted to Property Owner Split
Arthur fires this webhook when the Transaction event "Remitted to Property Owner Split" occurs in the subscribed entity.
transactionRemittedToPropertyOwner
Transaction: Remitted to Property Owner
Arthur fires this webhook when the Transaction event "Remitted to Property Owner" occurs in the subscribed entity.
unitUnitAdded
Unit: Unit Added
Arthur fires this webhook when the Unit event "Unit Added" occurs in the subscribed entity.
unitUnitSetToAvailableToLet
Unit: Unit set to available to let
Arthur fires this webhook when the Unit event "Unit set to available to let" occurs in the subscribed entity.
unitUnitUpdated
Unit: Unit updated
Arthur fires this webhook when the Unit event "Unit updated" occurs in the subscribed entity.
utilityreadingUtilityReadingAdded
UtilityReading: Utility Reading Added
Arthur fires this webhook when the UtilityReading event "Utility Reading Added" occurs in the subscribed entity.
viewingAddedLettingViewingByPropertyManager
Viewing: Added Letting Viewing by Property Manager
Arthur fires this webhook when the Viewing event "Added Letting Viewing by Property Manager" occurs in the subscribed entity.
viewingAddedSaleViewingByPropertyManager
Viewing: Added Sale Viewing by Property Manager
Arthur fires this webhook when the Viewing event "Added Sale Viewing by Property Manager" occurs in the subscribed entity.
viewingAddedViewingByLettingAgent
Viewing: Added Viewing by Letting Agent
Arthur fires this webhook when the Viewing event "Added Viewing by Letting Agent" occurs in the subscribed entity.
viewingUpdatedSaleViewingByPropertyManager
Viewing: Updated Sale Viewing by Property Manager
Arthur fires this webhook when the Viewing event "Updated Sale Viewing by Property Manager" occurs in the subscribed entity.
viewingUpdatedStatusSaleViewingByPropertyManager
Viewing: Updated status Sale Viewing by Property Manager
Arthur fires this webhook when the Viewing event "Updated status Sale Viewing by Property Manager" occurs in the subscribed entity.
viewingViewingCancelled
Viewing: Viewing Cancelled
Arthur fires this webhook when the Viewing event "Viewing Cancelled" occurs in the subscribed entity.
viewingViewingOfferEntered
Viewing: Viewing offer entered
Arthur fires this webhook when the Viewing event "Viewing offer entered" occurs in the subscribed entity.
viewingViewingUpdatedByLettingAgent
Viewing: Viewing updated by Letting Agent
Arthur fires this webhook when the Viewing event "Viewing updated by Letting Agent" occurs in the subscribed entity.
viewingViewingUpdatedByPropertyManager
Viewing: Viewing updated by Property Manager
Arthur fires this webhook when the Viewing event "Viewing updated by Property Manager" occurs in the subscribed entity.
viewingapplicantApplicantAddedToViewing
ViewingApplicant: Applicant added to viewing
Arthur fires this webhook when the ViewingApplicant event "Applicant added to viewing" occurs in the subscribed entity.
vulnerabilityprofileTenantCOVIDProfileUpdated
VulnerabilityProfile: Tenant COVID Profile updated
Arthur fires this webhook when the VulnerabilityProfile event "Tenant COVID Profile updated" occurs in the subscribed entity.
workorderNewWorkorderAdded
Workorder: New Workorder added
Arthur fires this webhook when the Workorder event "New Workorder added" occurs in the subscribed entity.
workorderPropertyManagerApprovesCompletedWorkorder
Workorder: Property Manager approves completed workorder
Arthur fires this webhook when the Workorder event "Property Manager approves completed workorder" occurs in the subscribed entity.
workorderRequireApprovalFromPropertyOwner
Workorder: Require approval from Property Owner
Arthur fires this webhook when the Workorder event "Require approval from Property Owner" occurs in the subscribed entity.
workorderWorkorderAssignedToContractor
Workorder: Workorder Assigned to Contractor
Arthur fires this webhook when the Workorder event "Workorder Assigned to Contractor" occurs in the subscribed entity.
workorderWorkorderCancelled
Workorder: Workorder Cancelled
Arthur fires this webhook when the Workorder event "Workorder Cancelled" occurs in the subscribed entity.
workorderWorkorderOnHold
Workorder: Workorder On Hold
Arthur fires this webhook when the Workorder event "Workorder On Hold" occurs in the subscribed entity.
workorderWorkorderReallocated
Workorder: Workorder Reallocated
Arthur fires this webhook when the Workorder event "Workorder Reallocated" occurs in the subscribed entity.
workorderWorkorderResumed
Workorder: Workorder Resumed
Arthur fires this webhook when the Workorder event "Workorder Resumed" occurs in the subscribed entity.
workorderentityContractorInvitedToWorkorder
WorkorderEntity: Contractor Invited to Workorder
Arthur fires this webhook when the WorkorderEntity event "Contractor Invited to Workorder" occurs in the subscribed entity.
workorderentityContractorSetWorkorderToCompleted
WorkorderEntity: Contractor set workorder to completed
Arthur fires this webhook when the WorkorderEntity event "Contractor set workorder to completed" occurs in the subscribed entity.
workorderentityWorkorderDeclinedByContractor
WorkorderEntity: Workorder Declined by Contractor
Arthur fires this webhook when the WorkorderEntity event "Workorder Declined by Contractor" occurs in the subscribed entity.
workorderinvoiceContractorCreatesInvoice
WorkorderInvoice: Contractor creates invoice
Arthur fires this webhook when the WorkorderInvoice event "Contractor creates invoice" occurs in the subscribed entity.
workorderinvoicePropertyManagerSetWorkorderInvoiceToPaid
WorkorderInvoice: Property Manager set workorder invoice to Paid
Arthur fires this webhook when the WorkorderInvoice event "Property Manager set workorder invoice to Paid" occurs in the subscribed entity.
workorderquoteContractorProvidedWorkorderQuote
WorkorderQuote: Contractor provided workorder quote
Arthur fires this webhook when the WorkorderQuote event "Contractor provided workorder quote" occurs in the subscribed entity.
workorderquotePropertyManagerAcceptedQuote
WorkorderQuote: Property Manager Accepted Quote
Arthur fires this webhook when the WorkorderQuote event "Property Manager Accepted Quote" occurs in the subscribed entity.
workorderquotePropertyOwnerAcceptedQuote
WorkorderQuote: Property Owner Accepted Quote
Arthur fires this webhook when the WorkorderQuote event "Property Owner Accepted Quote" occurs in the subscribed entity.
workorderquotePropertyOwnerRejectedQuote
WorkorderQuote: Property Owner Rejected Quote
Arthur fires this webhook when the WorkorderQuote event "Property Owner Rejected Quote" occurs in the subscribed entity.
workorderquoteWorkorderAcceptedByContractorToQuote
WorkorderQuote: Workorder Accepted by Contractor to Quote
Arthur fires this webhook when the WorkorderQuote event "Workorder Accepted by Contractor to Quote" occurs in the subscribed entity.
Servers
https
subscriber
The subscriber-supplied HTTPS endpoint registered on the Arthur webhook page. Arthur is the publisher; the integrator's server is the subscriber.