EverReal
  • Introduction
  • Authentication
    • API ClientID and ClientSecret
    • Authentication limitations
  • Rate limiting
  • Helpers
    • Errors
    • Pagination
    • Formatting
  • How to guide
    • EverReal Data Import Process
      • Connect an Integration
      • Import Mappers
      • Ideal CSV Structure
      • Debug Imports
      • FAQ
    • Data import via GraphQL
  • Endpoints
    • Account users / members
    • Owners
      • Owners Query
      • Owners Mutation
    • Property Groups
      • Property Groups Query
      • Property Group Mutation
    • Properties
      • Properties Query
      • Properties Mutation
    • Units
      • Units Query
      • Units Mutation
    • Listing
      • Listing Query
      • Listing Mutation
    • Candidates
      • Candidates Query
      • Candidate Mutation
    • Messages
    • Contact Activites
    • Tenants
      • Tenants Query
      • Tenant Mutation
    • Contract
      • Contract Query
      • Contract Mutation
    • Contacts
      • Contact Mutation
      • Contact Query
    • Document management
      • Document management
      • Simple file upload
    • Tasks
      • Tasks Query
    • Protocols
      • Protocol Query
  • Webhooks
    • Owner Events
      • OWNER_CREATED
      • OWNER_UPDATED
      • OWNER_DELETED
    • Property Events
      • PROPERTY_CREATED
      • PROPERTY_UPDATED
      • PROPERTY_DELETED
    • Unit Events
      • UNIT_CREATED
      • UNIT_UPDATED
      • UNIT_DELETED
    • Listing Events
      • LISTING_ACTIVATED
      • LISTING_ARCHIVED
      • LISTING_UPDATED
      • LISTING_DEACTIVATED
      • LISTING_CREATED
      • LISTING_PUBLISHED_TO_CHANNEL
      • LISTING_UNPUBLISHED_FROM_CHANNEL
    • Candidates Events
      • CANDIDATE_PARSED
      • LISTING_CANDIDATE_APPLIED
    • Listing Contracting Events
      • LISTING_CONTRACT_FLOW_SIGNED
      • LISTING_CONTRACT_FLOW_PARTIALLY_SIGNED
      • LISTING_CONTRACT_FLOW_WITHDRAWN
      • LISTING_CONTRACT_FLOW_STARTED
    • Listing Scheduling Events
      • LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKING_REMOVED_CANDIDATE
      • LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKING_REMOVED_ADMIN
      • LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKED_CANDIDATE
      • LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKED_ADMIN
      • LISTING_CANDIDATE_SCHEDULE_NEW_TIMESLOTS_REQUESTED
      • LISTING_CANDIDATE_SCHEDULE_INVITED_VIEWING
    • Protocol Events
      • PROTOCOL_COMPLETED
  • Change log
    • Releases
      • Introducing Mappers
      • Enhancements for GraphQL
      • Enhancements for Querying
      • Enhancements for Webhooks
    • Upcoming
      • Introduced Querying Protocol in GraphQL
Powered by GitBook
On this page

Was this helpful?

  1. Webhooks
  2. Protocol Events

PROTOCOL_COMPLETED

Payload submitted when EverReal send a notification for PROTOCOL_COMPLETED

interface IProtocolAction {
    id:string
    companyId: string;
    protocolType?: string;
    protocolVersion?: string;
    protocolVersion: ProtocolVersion
    companyId: string
    propertyId: string
    unitId: string
    documentId: string
    additionalNotes: string
    moveInExtraInformation: MoveInExtraInformation
    moveOutExtraInformation: MoveOutExtraInformation
    sellingExtraInformation: SellingExtraInformation
    uploadsRootId: string
    draftId: string
    protocolType: ProtocolType
    createdAt: string
    updatedAt: string
    deletedAt: string
    property: {
        id:string
        }
    unit: {
        id : string
       }
    company: {
        id:string
      }
    rooms: [ProtocolRoom]
    meters: [ProtocolMeter]
    keysets: [ProtocolKeyset]
    persons: [ProtocolPerson]
    signatureAcknowledgementText: string
 }

enum ProtocolType {
  MOVE_IN
  MOVE_OUT
  SELLING
  PRE_MOVE_OUT
}

enum ProtocolVersion {
  V1
  V2
}

type ProtocolMeter {
  id: string
  protocolId: string
  unitMeterId: string
  stand: string
  type: ProtocolMeterType
  number: string
  pictures: [File]
}

type ProtocolKeyset {
  id: id
  protocolId: string
  unitKeysetId: string
  quantity: number
  type: ProtocolKeysetType
  model: string
  pictures: [File]
  keyNumbers: [ProtocolKeyNumber]
}

type ProtocolPerson {
  id: id
  protocolId: string
  companyContactId: string
  email: string
  firstName: string
  lastName: string
  phoneNumber: string
}
PreviousProtocol EventsNextChange log

Last updated 11 days ago

Was this helpful?