Get real-time account and portal submission events.
With Webhooks we POST a JSON message to a URL you specify whenever specific events take place within a branch account.
If you have multiple branches you can apply the same URL to receive updates on each.
When we try to send POST data to your callback URL, the returned HTTP status code will be checked. If your callback URL doesn't respond with either a 200, 301, 302 status code or the URL timed out, our system will try again 2 more times before cancelling. Each repeat attempt to send the POST data to your callback URL will be in 30 minute intervals.
This event is fired when a property is manually or automatically submitted to a real-time portal account with either a success or error response.
eaf_type: [string] - the type of webhook that the data relates. eaf_status: [string] [success, error] - whether the submission was successfull or returned an error. eaf_action: [string] [create, update, delete] - the type of action that was requested. eaf_target: [string] [rightmove, zoopla, onthemarket] - the property portal the submission was sent. eaf_id: [string] - our unique ID for this submission. eaf_date: [datetime] - the date and time of the portal submission. eaf_timestamp: [number] - the date and time of the portal submission in unix timestamp format. eaf_reference: [string] - the original reference number for the property record. eaf_portal_reference: [string] - the reference number for the property record that was sent to and recorded by the portal. eaf_remote_url: [string] - the returned URL for the property record on the portal. Only present if eaf_action equals create or update.
If the eaf_status equals error, the following values are provided.
eaf_errors: [array] - contains one or more error blocks. eaf_code: [string] - our fixed error code for the type of error received. eaf_message: [string] - our description of the error received from the portal.
For a complete list of our error codes, please contact account support.
This event is fired when a property datafeed is successfully imported into your account and included 1 or more records being created, updated or deleted.
eaf_type: [string] - the type of webhook that the data relates. eaf_format: [string] [blm, xml_eaf_spec, xml_kyero, xml_vebra, xml_jupix] - the datafeed internal identifier. This list is not exhaustive. eaf_id: [string] - our unique ID for this submission. eaf_agent_id: [string] - the unique agent or sub manager ID. eaf_agent_name: [string] - the name of the agent or sub manager that the import relates. eaf_agent_email: [string] - the email address of the agent or sub manager. eaf_records_modified: [number] - the total number or records that were created, updated and or deleted during the import. eaf_source: [string] - the URL, source type, or filename of the datafeed used during the import. eaf_date: [datetime] - the date and time of the import. eaf_timestamp: [number] - the date and time of the import in unix timestamp format.
This event is fired when a portal email lead is imported into your account from one of the supported websites.
eaf_type: [string] - the type of webhook that the data relates. eaf_id: [string] - our unique ID for this submission. id: [string] - the unique ID for the record. email_source: [string] - the source of the lead. email_date_time: [datetime] - the origin date of the lead enquiry. contact_name: [string] - the name of the contact who made the enquiry. contact_email: [string] - the email address of the contact who made the enquiry. contact_phone: [string] - the phone number of the contact who made the enquiry. contact_message_html: [string] - the message left by the contact who made the enquiry with line-breaks. contact_message_flat: [string] - the message left by the contact who made the enquiry without line-breaks. eaf_reference: [string] - the agency reference for the property the enquiry relates. eaf_portal_reference: [string] - the reference we sent to the portal for the property the enquiry relates. eaf_development_reference: [string] - the reference for the development the enquiry relates. eaf_date: [datetime] - the date and time of the lead enquiry being created. eaf_timestamp: [number] - the date and time of the lead being created in unix timestamp format.
Please email support@estateagentfeeds.com if you require help with our Webhooks.
Ok message
Error message