> ## Documentation Index
> Fetch the complete documentation index at: https://docs.signalproptech.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List events

> The agency's events from the last 30 days, oldest first, delivered or not, in the same envelope as the webhook. Leave out `after` to start from the oldest. An `after` we never issued is a 422.



## OpenAPI

````yaml /openapi.json get /events
openapi: 3.1.0
info:
  title: Signal Partner API
  description: >-
    Send Signal enquiries, viewings and listings from your system, and receive
    what Signal learns back as signed webhooks. Every call is in beta:
    documented ahead of going live, it answers `501 not_available_yet` until
    then.
  contact:
    name: Signal
    url: https://signalproptech.com/
  version: 1.0.0-beta
servers:
  - url: https://api.signalproptech.com/api/v1/partner
    description: Production
security: []
tags:
  - name: Enquiries
    description: >-
      Hand Signal an enquiry that started in your system, and read where it
      stands.
  - name: Viewings
    description: >-
      Tell Signal about viewings booked in your system, so it can remind and ask
      for feedback.
  - name: Listings and new homes
    description: >-
      Keep Signal's copy of your listings, developments, units and reservations
      up to date.
  - name: Webhooks
    description: >-
      Register where Signal sends events, test it, and catch up on what you
      missed.
  - name: Events
    description: >-
      What Signal sends to your webhook, one page per event type. Check the
      webhook- headers before trusting the body.
paths:
  /events:
    get:
      tags:
        - Webhooks
      summary: List events
      description: >-
        The agency's events from the last 30 days, oldest first, delivered or
        not, in the same envelope as the webhook. Leave out `after` to start
        from the oldest. An `after` we never issued is a 422.
      operationId: list_events
      parameters:
        - name: after
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 64
                minLength: 1
              - type: 'null'
            description: The last event id you processed.
            title: After
          description: The last event id you processed.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            description: How many events per page, 1 to 500.
            default: 100
            title: Limit
          description: How many events per page, 1 to 500.
      responses:
        '200':
          description: A page of events, oldest first.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventsPage'
        '401':
          description: The key is missing, unknown or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '410':
          description: >-
            Your `after` is older than 30 days. Start again without it and
            reconcile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Validation failed. `fields` lists each problem.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limited. Retry after the number of seconds in `Retry-After`.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '501':
          description: Not live yet (beta).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
        - AgencyKey: []
components:
  schemas:
    EventsPage:
      properties:
        events:
          items:
            oneOf:
              - $ref: '#/components/schemas/EnquiryReceived'
              - $ref: '#/components/schemas/EnquiryQualified'
              - $ref: '#/components/schemas/EnquiryGoneQuiet'
              - $ref: '#/components/schemas/EnquiryOptedOut'
              - $ref: '#/components/schemas/EnquiryAskedForPerson'
              - $ref: '#/components/schemas/ViewingCantMakeIt'
              - $ref: '#/components/schemas/ViewingFeedbackCaptured'
              - $ref: '#/components/schemas/NoteAdded'
              - $ref: '#/components/schemas/ShowhomeBookingMade'
              - $ref: '#/components/schemas/ShowhomeBookingChanged'
              - $ref: '#/components/schemas/ShowhomeBookingCancelled'
              - $ref: '#/components/schemas/ShowhomeVisitRecorded'
              - $ref: '#/components/schemas/DevelopmentInterestRegistered'
              - $ref: '#/components/schemas/WebhookTest'
            discriminator:
              propertyName: type
              mapping:
                development.interest_registered: '#/components/schemas/DevelopmentInterestRegistered'
                enquiry.asked_for_person: '#/components/schemas/EnquiryAskedForPerson'
                enquiry.gone_quiet: '#/components/schemas/EnquiryGoneQuiet'
                enquiry.opted_out: '#/components/schemas/EnquiryOptedOut'
                enquiry.qualified: '#/components/schemas/EnquiryQualified'
                enquiry.received: '#/components/schemas/EnquiryReceived'
                note.added: '#/components/schemas/NoteAdded'
                showhome.booking_cancelled: '#/components/schemas/ShowhomeBookingCancelled'
                showhome.booking_changed: '#/components/schemas/ShowhomeBookingChanged'
                showhome.booking_made: '#/components/schemas/ShowhomeBookingMade'
                showhome.visit_recorded: '#/components/schemas/ShowhomeVisitRecorded'
                viewing.cant_make_it: '#/components/schemas/ViewingCantMakeIt'
                viewing.feedback_captured: '#/components/schemas/ViewingFeedbackCaptured'
                webhook.test: '#/components/schemas/WebhookTest'
          type: array
          title: Events
          description: The events on this page, oldest first.
        next_after:
          anyOf:
            - type: string
            - type: 'null'
          title: Next After
          description: >-
            Pass as `after` next time: the last event's id, or your own `after`
            when there was nothing new. Absent only when there are no events yet
            and you sent no `after`.
        has_more:
          type: boolean
          title: Has More
          description: 'True when more events follow this page: call again straight away.'
      type: object
      required:
        - events
        - has_more
      title: EventsPage
      description: A page of events.
    ErrorBody:
      properties:
        error:
          type: string
          title: Error
          description: >-
            Stable machine code: validation_failed, unauthorized, bad_request,
            forbidden, not_found, method_not_allowed, conflict, too_large,
            unsupported_media_type, rate_limited, cursor_expired,
            not_available_yet or internal_error. Any other status gives error.
        message:
          type: string
          title: Message
          description: What went wrong, in plain English.
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: Quote this to us and we can find the call.
        fields:
          items:
            $ref: '#/components/schemas/FieldError'
          type: array
          title: Fields
          description: Each problem with the request. Empty for other errors.
      type: object
      required:
        - error
        - message
      title: ErrorBody
      description: Every error has this shape.
    EnquiryReceived:
      properties:
        id:
          type: string
          title: Id
          description: evt_… The same as the webhook-id header. Use it to skip repeats.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: When it happened, in UTC.
        agency_id:
          type: string
          format: uuid
          title: Agency Id
          description: Signal's id for the agency.
        contact_id:
          type: string
          format: uuid
          title: Contact Id
          description: Signal's id for the person. Store it.
        contact_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact External Id
          description: Your contact id, once we know it.
        contact:
          allOf:
            - $ref: '#/components/schemas/EventContact'
          description: Who it's about, so you can find or create them.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            On enquiry events: where the enquiry first reached Signal: daft,
            myhome, website, phone, walk_in, whatsapp, email or other. For an
            enquiry you sent, the source you gave.
        enquiry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Enquiry Id
          description: Signal's id for the enquiry, when the event is about one.
        enquiry_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Enquiry External Id
          description: Your enquiry id, when the event is about an enquiry you sent us.
        viewing_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Viewing Id
          description: >-
            Signal's id for the viewing, on viewing events and show-home
            bookings.
        viewing_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Viewing External Id
          description: Your viewing id, when the event is about a viewing you sent us.
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: sale or letting. New homes are sales with property.development set.
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Code
          description: The agency branch, by the codes agreed with the agency.
        property:
          anyOf:
            - $ref: '#/components/schemas/EventProperty'
            - type: 'null'
          description: The property it's about, with your reference when we can match it.
        type:
          const: enquiry.received
          title: Type
          description: The event type. Decides the shape of data.
        data:
          allOf:
            - $ref: '#/components/schemas/ReceivedData'
          description: What happened. Its shape depends on type.
      type: object
      required:
        - id
        - timestamp
        - agency_id
        - contact_id
        - contact
        - type
        - data
      title: EnquiryReceived
      description: >-
        An enquiry was received: one you sent, or one that reached Signal
        directly if the agency logs WhatsApp enquiries.
    EnquiryQualified:
      properties:
        id:
          type: string
          title: Id
          description: evt_… The same as the webhook-id header. Use it to skip repeats.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: When it happened, in UTC.
        agency_id:
          type: string
          format: uuid
          title: Agency Id
          description: Signal's id for the agency.
        contact_id:
          type: string
          format: uuid
          title: Contact Id
          description: Signal's id for the person. Store it.
        contact_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact External Id
          description: Your contact id, once we know it.
        contact:
          allOf:
            - $ref: '#/components/schemas/EventContact'
          description: Who it's about, so you can find or create them.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            On enquiry events: where the enquiry first reached Signal: daft,
            myhome, website, phone, walk_in, whatsapp, email or other. For an
            enquiry you sent, the source you gave.
        enquiry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Enquiry Id
          description: Signal's id for the enquiry, when the event is about one.
        enquiry_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Enquiry External Id
          description: Your enquiry id, when the event is about an enquiry you sent us.
        viewing_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Viewing Id
          description: >-
            Signal's id for the viewing, on viewing events and show-home
            bookings.
        viewing_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Viewing External Id
          description: Your viewing id, when the event is about a viewing you sent us.
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: sale or letting. New homes are sales with property.development set.
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Code
          description: The agency branch, by the codes agreed with the agency.
        property:
          anyOf:
            - $ref: '#/components/schemas/EventProperty'
            - type: 'null'
          description: The property it's about, with your reference when we can match it.
        type:
          const: enquiry.qualified
          title: Type
          description: The event type. Decides the shape of data.
        data:
          oneOf:
            - $ref: '#/components/schemas/SaleQualification'
            - $ref: '#/components/schemas/LettingQualification'
          title: Data
          description: What happened. Its shape depends on type.
          discriminator:
            propertyName: kind
            mapping:
              letting: '#/components/schemas/LettingQualification'
              sale: '#/components/schemas/SaleQualification'
      type: object
      required:
        - id
        - timestamp
        - agency_id
        - contact_id
        - contact
        - type
        - data
      title: EnquiryQualified
      description: The person answered the qualifying questions.
    EnquiryGoneQuiet:
      properties:
        id:
          type: string
          title: Id
          description: evt_… The same as the webhook-id header. Use it to skip repeats.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: When it happened, in UTC.
        agency_id:
          type: string
          format: uuid
          title: Agency Id
          description: Signal's id for the agency.
        contact_id:
          type: string
          format: uuid
          title: Contact Id
          description: Signal's id for the person. Store it.
        contact_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact External Id
          description: Your contact id, once we know it.
        contact:
          allOf:
            - $ref: '#/components/schemas/EventContact'
          description: Who it's about, so you can find or create them.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            On enquiry events: where the enquiry first reached Signal: daft,
            myhome, website, phone, walk_in, whatsapp, email or other. For an
            enquiry you sent, the source you gave.
        enquiry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Enquiry Id
          description: Signal's id for the enquiry, when the event is about one.
        enquiry_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Enquiry External Id
          description: Your enquiry id, when the event is about an enquiry you sent us.
        viewing_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Viewing Id
          description: >-
            Signal's id for the viewing, on viewing events and show-home
            bookings.
        viewing_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Viewing External Id
          description: Your viewing id, when the event is about a viewing you sent us.
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: sale or letting. New homes are sales with property.development set.
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Code
          description: The agency branch, by the codes agreed with the agency.
        property:
          anyOf:
            - $ref: '#/components/schemas/EventProperty'
            - type: 'null'
          description: The property it's about, with your reference when we can match it.
        type:
          const: enquiry.gone_quiet
          title: Type
          description: The event type. Decides the shape of data.
        data:
          allOf:
            - $ref: '#/components/schemas/GoneQuietData'
          description: What happened. Its shape depends on type.
      type: object
      required:
        - id
        - timestamp
        - agency_id
        - contact_id
        - contact
        - type
        - data
      title: EnquiryGoneQuiet
      description: Our follow-up went unanswered.
    EnquiryOptedOut:
      properties:
        id:
          type: string
          title: Id
          description: evt_… The same as the webhook-id header. Use it to skip repeats.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: When it happened, in UTC.
        agency_id:
          type: string
          format: uuid
          title: Agency Id
          description: Signal's id for the agency.
        contact_id:
          type: string
          format: uuid
          title: Contact Id
          description: Signal's id for the person. Store it.
        contact_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact External Id
          description: Your contact id, once we know it.
        contact:
          allOf:
            - $ref: '#/components/schemas/EventContact'
          description: Who it's about, so you can find or create them.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            On enquiry events: where the enquiry first reached Signal: daft,
            myhome, website, phone, walk_in, whatsapp, email or other. For an
            enquiry you sent, the source you gave.
        enquiry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Enquiry Id
          description: Signal's id for the enquiry, when the event is about one.
        enquiry_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Enquiry External Id
          description: Your enquiry id, when the event is about an enquiry you sent us.
        viewing_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Viewing Id
          description: >-
            Signal's id for the viewing, on viewing events and show-home
            bookings.
        viewing_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Viewing External Id
          description: Your viewing id, when the event is about a viewing you sent us.
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: sale or letting. New homes are sales with property.development set.
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Code
          description: The agency branch, by the codes agreed with the agency.
        property:
          anyOf:
            - $ref: '#/components/schemas/EventProperty'
            - type: 'null'
          description: The property it's about, with your reference when we can match it.
        type:
          const: enquiry.opted_out
          title: Type
          description: The event type. Decides the shape of data.
        data:
          allOf:
            - $ref: '#/components/schemas/OptedOutData'
          description: What happened. Its shape depends on type.
      type: object
      required:
        - id
        - timestamp
        - agency_id
        - contact_id
        - contact
        - type
        - data
      title: EnquiryOptedOut
      description: The person asked us to stop.
    EnquiryAskedForPerson:
      properties:
        id:
          type: string
          title: Id
          description: evt_… The same as the webhook-id header. Use it to skip repeats.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: When it happened, in UTC.
        agency_id:
          type: string
          format: uuid
          title: Agency Id
          description: Signal's id for the agency.
        contact_id:
          type: string
          format: uuid
          title: Contact Id
          description: Signal's id for the person. Store it.
        contact_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact External Id
          description: Your contact id, once we know it.
        contact:
          allOf:
            - $ref: '#/components/schemas/EventContact'
          description: Who it's about, so you can find or create them.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            On enquiry events: where the enquiry first reached Signal: daft,
            myhome, website, phone, walk_in, whatsapp, email or other. For an
            enquiry you sent, the source you gave.
        enquiry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Enquiry Id
          description: Signal's id for the enquiry, when the event is about one.
        enquiry_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Enquiry External Id
          description: Your enquiry id, when the event is about an enquiry you sent us.
        viewing_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Viewing Id
          description: >-
            Signal's id for the viewing, on viewing events and show-home
            bookings.
        viewing_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Viewing External Id
          description: Your viewing id, when the event is about a viewing you sent us.
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: sale or letting. New homes are sales with property.development set.
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Code
          description: The agency branch, by the codes agreed with the agency.
        property:
          anyOf:
            - $ref: '#/components/schemas/EventProperty'
            - type: 'null'
          description: The property it's about, with your reference when we can match it.
        type:
          const: enquiry.asked_for_person
          title: Type
          description: The event type. Decides the shape of data.
        data:
          allOf:
            - $ref: '#/components/schemas/AskedForPersonData'
          description: What happened. Its shape depends on type.
      type: object
      required:
        - id
        - timestamp
        - agency_id
        - contact_id
        - contact
        - type
        - data
      title: EnquiryAskedForPerson
      description: The person asked to speak to someone.
    ViewingCantMakeIt:
      properties:
        id:
          type: string
          title: Id
          description: evt_… The same as the webhook-id header. Use it to skip repeats.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: When it happened, in UTC.
        agency_id:
          type: string
          format: uuid
          title: Agency Id
          description: Signal's id for the agency.
        contact_id:
          type: string
          format: uuid
          title: Contact Id
          description: Signal's id for the person. Store it.
        contact_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact External Id
          description: Your contact id, once we know it.
        contact:
          allOf:
            - $ref: '#/components/schemas/EventContact'
          description: Who it's about, so you can find or create them.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            On enquiry events: where the enquiry first reached Signal: daft,
            myhome, website, phone, walk_in, whatsapp, email or other. For an
            enquiry you sent, the source you gave.
        enquiry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Enquiry Id
          description: Signal's id for the enquiry, when the event is about one.
        enquiry_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Enquiry External Id
          description: Your enquiry id, when the event is about an enquiry you sent us.
        viewing_id:
          type: string
          format: uuid
          title: Viewing Id
          description: Signal's id for the viewing.
        viewing_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Viewing External Id
          description: Your viewing id, when the event is about a viewing you sent us.
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: sale or letting. New homes are sales with property.development set.
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Code
          description: The agency branch, by the codes agreed with the agency.
        property:
          anyOf:
            - $ref: '#/components/schemas/EventProperty'
            - type: 'null'
          description: The property it's about, with your reference when we can match it.
        type:
          const: viewing.cant_make_it
          title: Type
          description: The event type. Decides the shape of data.
        data:
          allOf:
            - $ref: '#/components/schemas/CantMakeItData'
          description: What happened. Its shape depends on type.
      type: object
      required:
        - id
        - timestamp
        - agency_id
        - contact_id
        - contact
        - viewing_id
        - type
        - data
      title: ViewingCantMakeIt
      description: The viewer tapped can't make it on the day-before reminder.
    ViewingFeedbackCaptured:
      properties:
        id:
          type: string
          title: Id
          description: evt_… The same as the webhook-id header. Use it to skip repeats.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: When it happened, in UTC.
        agency_id:
          type: string
          format: uuid
          title: Agency Id
          description: Signal's id for the agency.
        contact_id:
          type: string
          format: uuid
          title: Contact Id
          description: Signal's id for the person. Store it.
        contact_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact External Id
          description: Your contact id, once we know it.
        contact:
          allOf:
            - $ref: '#/components/schemas/EventContact'
          description: Who it's about, so you can find or create them.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            On enquiry events: where the enquiry first reached Signal: daft,
            myhome, website, phone, walk_in, whatsapp, email or other. For an
            enquiry you sent, the source you gave.
        enquiry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Enquiry Id
          description: Signal's id for the enquiry, when the event is about one.
        enquiry_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Enquiry External Id
          description: Your enquiry id, when the event is about an enquiry you sent us.
        viewing_id:
          type: string
          format: uuid
          title: Viewing Id
          description: Signal's id for the viewing.
        viewing_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Viewing External Id
          description: Your viewing id, when the event is about a viewing you sent us.
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: sale or letting. New homes are sales with property.development set.
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Code
          description: The agency branch, by the codes agreed with the agency.
        property:
          anyOf:
            - $ref: '#/components/schemas/EventProperty'
            - type: 'null'
          description: The property it's about, with your reference when we can match it.
        type:
          const: viewing.feedback_captured
          title: Type
          description: The event type. Decides the shape of data.
        data:
          oneOf:
            - $ref: '#/components/schemas/SaleFeedback'
            - $ref: '#/components/schemas/LettingFeedback'
          title: Data
          description: What happened. Its shape depends on type.
          discriminator:
            propertyName: kind
            mapping:
              letting: '#/components/schemas/LettingFeedback'
              sale: '#/components/schemas/SaleFeedback'
      type: object
      required:
        - id
        - timestamp
        - agency_id
        - contact_id
        - contact
        - viewing_id
        - type
        - data
      title: ViewingFeedbackCaptured
      description: The person gave feedback after a viewing.
    NoteAdded:
      properties:
        id:
          type: string
          title: Id
          description: evt_… The same as the webhook-id header. Use it to skip repeats.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: When it happened, in UTC.
        agency_id:
          type: string
          format: uuid
          title: Agency Id
          description: Signal's id for the agency.
        contact_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Contact Id
          description: Signal's id for the person. Store it.
        contact_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact External Id
          description: Your contact id, once we know it.
        contact:
          anyOf:
            - $ref: '#/components/schemas/EventContact'
            - type: 'null'
          description: Who it's about, when it's about a person.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            On enquiry events: where the enquiry first reached Signal: daft,
            myhome, website, phone, walk_in, whatsapp, email or other. For an
            enquiry you sent, the source you gave.
        enquiry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Enquiry Id
          description: Signal's id for the enquiry, when the event is about one.
        enquiry_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Enquiry External Id
          description: Your enquiry id, when the event is about an enquiry you sent us.
        viewing_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Viewing Id
          description: >-
            Signal's id for the viewing, on viewing events and show-home
            bookings.
        viewing_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Viewing External Id
          description: Your viewing id, when the event is about a viewing you sent us.
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: sale or letting. New homes are sales with property.development set.
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Code
          description: The agency branch, by the codes agreed with the agency.
        property:
          anyOf:
            - $ref: '#/components/schemas/EventProperty'
            - type: 'null'
          description: The property it's about, with your reference when we can match it.
        type:
          const: note.added
          title: Type
          description: The event type. Decides the shape of data.
        data:
          allOf:
            - $ref: '#/components/schemas/NoteData'
          description: What happened. Its shape depends on type.
      type: object
      required:
        - id
        - timestamp
        - agency_id
        - type
        - data
      title: NoteAdded
      description: A note for the person's, viewing's or property's record.
    ShowhomeBookingMade:
      properties:
        id:
          type: string
          title: Id
          description: evt_… The same as the webhook-id header. Use it to skip repeats.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: When it happened, in UTC.
        agency_id:
          type: string
          format: uuid
          title: Agency Id
          description: Signal's id for the agency.
        contact_id:
          type: string
          format: uuid
          title: Contact Id
          description: Signal's id for the person. Store it.
        contact_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact External Id
          description: Your contact id, once we know it.
        contact:
          allOf:
            - $ref: '#/components/schemas/EventContact'
          description: Who it's about, so you can find or create them.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            On enquiry events: where the enquiry first reached Signal: daft,
            myhome, website, phone, walk_in, whatsapp, email or other. For an
            enquiry you sent, the source you gave.
        enquiry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Enquiry Id
          description: Signal's id for the enquiry, when the event is about one.
        enquiry_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Enquiry External Id
          description: Your enquiry id, when the event is about an enquiry you sent us.
        viewing_id:
          type: string
          format: uuid
          title: Viewing Id
          description: Signal's id for the booking.
        viewing_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Viewing External Id
          description: Your viewing id, when the event is about a viewing you sent us.
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: sale or letting. New homes are sales with property.development set.
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Code
          description: The agency branch, by the codes agreed with the agency.
        property:
          anyOf:
            - $ref: '#/components/schemas/EventProperty'
            - type: 'null'
          description: The property it's about, with your reference when we can match it.
        type:
          const: showhome.booking_made
          title: Type
          description: The event type. Decides the shape of data.
        data:
          allOf:
            - $ref: '#/components/schemas/ShowhomeBookingData'
          description: What happened. Its shape depends on type.
      type: object
      required:
        - id
        - timestamp
        - agency_id
        - contact_id
        - contact
        - viewing_id
        - type
        - data
      title: ShowhomeBookingMade
      description: Someone booked a show-home visit in Signal.
    ShowhomeBookingChanged:
      properties:
        id:
          type: string
          title: Id
          description: evt_… The same as the webhook-id header. Use it to skip repeats.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: When it happened, in UTC.
        agency_id:
          type: string
          format: uuid
          title: Agency Id
          description: Signal's id for the agency.
        contact_id:
          type: string
          format: uuid
          title: Contact Id
          description: Signal's id for the person. Store it.
        contact_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact External Id
          description: Your contact id, once we know it.
        contact:
          allOf:
            - $ref: '#/components/schemas/EventContact'
          description: Who it's about, so you can find or create them.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            On enquiry events: where the enquiry first reached Signal: daft,
            myhome, website, phone, walk_in, whatsapp, email or other. For an
            enquiry you sent, the source you gave.
        enquiry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Enquiry Id
          description: Signal's id for the enquiry, when the event is about one.
        enquiry_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Enquiry External Id
          description: Your enquiry id, when the event is about an enquiry you sent us.
        viewing_id:
          type: string
          format: uuid
          title: Viewing Id
          description: Signal's id for the booking.
        viewing_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Viewing External Id
          description: Your viewing id, when the event is about a viewing you sent us.
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: sale or letting. New homes are sales with property.development set.
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Code
          description: The agency branch, by the codes agreed with the agency.
        property:
          anyOf:
            - $ref: '#/components/schemas/EventProperty'
            - type: 'null'
          description: The property it's about, with your reference when we can match it.
        type:
          const: showhome.booking_changed
          title: Type
          description: The event type. Decides the shape of data.
        data:
          allOf:
            - $ref: '#/components/schemas/ShowhomeBookingData'
          description: What happened. Its shape depends on type.
      type: object
      required:
        - id
        - timestamp
        - agency_id
        - contact_id
        - contact
        - viewing_id
        - type
        - data
      title: ShowhomeBookingChanged
      description: A show-home booking moved.
    ShowhomeBookingCancelled:
      properties:
        id:
          type: string
          title: Id
          description: evt_… The same as the webhook-id header. Use it to skip repeats.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: When it happened, in UTC.
        agency_id:
          type: string
          format: uuid
          title: Agency Id
          description: Signal's id for the agency.
        contact_id:
          type: string
          format: uuid
          title: Contact Id
          description: Signal's id for the person. Store it.
        contact_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact External Id
          description: Your contact id, once we know it.
        contact:
          allOf:
            - $ref: '#/components/schemas/EventContact'
          description: Who it's about, so you can find or create them.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            On enquiry events: where the enquiry first reached Signal: daft,
            myhome, website, phone, walk_in, whatsapp, email or other. For an
            enquiry you sent, the source you gave.
        enquiry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Enquiry Id
          description: Signal's id for the enquiry, when the event is about one.
        enquiry_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Enquiry External Id
          description: Your enquiry id, when the event is about an enquiry you sent us.
        viewing_id:
          type: string
          format: uuid
          title: Viewing Id
          description: Signal's id for the booking.
        viewing_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Viewing External Id
          description: Your viewing id, when the event is about a viewing you sent us.
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: sale or letting. New homes are sales with property.development set.
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Code
          description: The agency branch, by the codes agreed with the agency.
        property:
          anyOf:
            - $ref: '#/components/schemas/EventProperty'
            - type: 'null'
          description: The property it's about, with your reference when we can match it.
        type:
          const: showhome.booking_cancelled
          title: Type
          description: The event type. Decides the shape of data.
        data:
          allOf:
            - $ref: '#/components/schemas/ShowhomeBookingData'
          description: What happened. Its shape depends on type.
      type: object
      required:
        - id
        - timestamp
        - agency_id
        - contact_id
        - contact
        - viewing_id
        - type
        - data
      title: ShowhomeBookingCancelled
      description: A show-home booking was cancelled.
    ShowhomeVisitRecorded:
      properties:
        id:
          type: string
          title: Id
          description: evt_… The same as the webhook-id header. Use it to skip repeats.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: When it happened, in UTC.
        agency_id:
          type: string
          format: uuid
          title: Agency Id
          description: Signal's id for the agency.
        contact_id:
          type: string
          format: uuid
          title: Contact Id
          description: Signal's id for the person. Store it.
        contact_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact External Id
          description: Your contact id, once we know it.
        contact:
          allOf:
            - $ref: '#/components/schemas/EventContact'
          description: Who it's about, so you can find or create them.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            On enquiry events: where the enquiry first reached Signal: daft,
            myhome, website, phone, walk_in, whatsapp, email or other. For an
            enquiry you sent, the source you gave.
        enquiry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Enquiry Id
          description: Signal's id for the enquiry, when the event is about one.
        enquiry_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Enquiry External Id
          description: Your enquiry id, when the event is about an enquiry you sent us.
        viewing_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Viewing Id
          description: >-
            Signal's id for the viewing, on viewing events and show-home
            bookings.
        viewing_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Viewing External Id
          description: Your viewing id, when the event is about a viewing you sent us.
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: sale or letting. New homes are sales with property.development set.
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Code
          description: The agency branch, by the codes agreed with the agency.
        property:
          anyOf:
            - $ref: '#/components/schemas/EventProperty'
            - type: 'null'
          description: The property it's about, with your reference when we can match it.
        type:
          const: showhome.visit_recorded
          title: Type
          description: The event type. Decides the shape of data.
        data:
          allOf:
            - $ref: '#/components/schemas/ShowhomeVisitData'
          description: What happened. Its shape depends on type.
      type: object
      required:
        - id
        - timestamp
        - agency_id
        - contact_id
        - contact
        - type
        - data
      title: ShowhomeVisitRecorded
      description: Someone checked in at the show home.
    DevelopmentInterestRegistered:
      properties:
        id:
          type: string
          title: Id
          description: evt_… The same as the webhook-id header. Use it to skip repeats.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: When it happened, in UTC.
        agency_id:
          type: string
          format: uuid
          title: Agency Id
          description: Signal's id for the agency.
        contact_id:
          type: string
          format: uuid
          title: Contact Id
          description: Signal's id for the person. Store it.
        contact_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact External Id
          description: Your contact id, once we know it.
        contact:
          allOf:
            - $ref: '#/components/schemas/EventContact'
          description: Who it's about, so you can find or create them.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            On enquiry events: where the enquiry first reached Signal: daft,
            myhome, website, phone, walk_in, whatsapp, email or other. For an
            enquiry you sent, the source you gave.
        enquiry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Enquiry Id
          description: Signal's id for the enquiry, when the event is about one.
        enquiry_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Enquiry External Id
          description: Your enquiry id, when the event is about an enquiry you sent us.
        viewing_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Viewing Id
          description: >-
            Signal's id for the viewing, on viewing events and show-home
            bookings.
        viewing_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Viewing External Id
          description: Your viewing id, when the event is about a viewing you sent us.
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: sale or letting. New homes are sales with property.development set.
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Code
          description: The agency branch, by the codes agreed with the agency.
        property:
          anyOf:
            - $ref: '#/components/schemas/EventProperty'
            - type: 'null'
          description: The property it's about, with your reference when we can match it.
        type:
          const: development.interest_registered
          title: Type
          description: The event type. Decides the shape of data.
        data:
          allOf:
            - $ref: '#/components/schemas/InterestData'
          description: What happened. Its shape depends on type.
      type: object
      required:
        - id
        - timestamp
        - agency_id
        - contact_id
        - contact
        - type
        - data
      title: DevelopmentInterestRegistered
      description: Someone registered interest in a development.
    WebhookTest:
      properties:
        id:
          type: string
          title: Id
          description: evt_… The same as the webhook-id header. Use it to skip repeats.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: When it happened, in UTC.
        agency_id:
          type: string
          format: uuid
          title: Agency Id
          description: Signal's id for the agency.
        contact_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Contact Id
          description: Signal's id for the person. Store it.
        contact_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact External Id
          description: Your contact id, once we know it.
        contact:
          anyOf:
            - $ref: '#/components/schemas/EventContact'
            - type: 'null'
          description: Who it's about, when it's about a person.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            On enquiry events: where the enquiry first reached Signal: daft,
            myhome, website, phone, walk_in, whatsapp, email or other. For an
            enquiry you sent, the source you gave.
        enquiry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Enquiry Id
          description: Signal's id for the enquiry, when the event is about one.
        enquiry_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Enquiry External Id
          description: Your enquiry id, when the event is about an enquiry you sent us.
        viewing_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Viewing Id
          description: >-
            Signal's id for the viewing, on viewing events and show-home
            bookings.
        viewing_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Viewing External Id
          description: Your viewing id, when the event is about a viewing you sent us.
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: sale or letting. New homes are sales with property.development set.
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Code
          description: The agency branch, by the codes agreed with the agency.
        property:
          anyOf:
            - $ref: '#/components/schemas/EventProperty'
            - type: 'null'
          description: The property it's about, with your reference when we can match it.
        type:
          const: webhook.test
          title: Type
          description: The event type. Decides the shape of data.
        data:
          allOf:
            - $ref: '#/components/schemas/EmptyData'
          description: What happened. Its shape depends on type.
      type: object
      required:
        - id
        - timestamp
        - agency_id
        - type
        - data
      title: WebhookTest
      description: You called POST /webhook/test.
    FieldError:
      properties:
        path:
          type: string
          title: Path
          description: >-
            Where the problem is, e.g. `contact.phone` or `house_types[0].name`.
            Empty for the request as a whole.
        code:
          type: string
          title: Code
          description: >-
            Stable code: required, empty, too_long, missing_offset, not_allowed,
            invalid_json or invalid.
        message:
          type: string
          title: Message
          description: What is wrong with this field, in plain English.
      type: object
      required:
        - path
        - code
        - message
      title: FieldError
      description: One problem with one field.
    EventContact:
      properties:
        first_name:
          anyOf:
            - type: string
            - type: 'null'
          title: First Name
          description: Their first name.
        last_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Name
          description: Their surname.
        phone:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone
          description: International format, e.g. +353861234567.
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
          description: Their email address, if we have one.
      type: object
      title: EventContact
      description: The person an event is about, as Signal holds them.
    EventProperty:
      properties:
        ref:
          anyOf:
            - type: string
            - type: 'null'
          title: Ref
          description: Your property reference, when Signal can match it.
        address:
          anyOf:
            - type: string
            - type: 'null'
          title: Address
          description: The property's address.
        development:
          anyOf:
            - $ref: '#/components/schemas/DevelopmentRef'
            - type: 'null'
          description: The development, for new homes.
      type: object
      title: EventProperty
      description: The property an event is about.
    ReceivedData:
      properties:
        conversation:
          type: string
          enum:
            - starting
            - existing_contact
            - not_started
          title: Conversation
          description: >-
            starting: the greeting is on its way. existing_contact: we already
            have a conversation with this mobile number. not_started: recorded,
            nothing sent (see reason).
        reason:
          anyOf:
            - type: string
              enum:
                - no_phone
                - not_mobile
                - no_consent
                - opted_out
                - stale
                - suppressed
                - transaction_type_off
                - whatsapp_not_connected
            - type: 'null'
          title: Reason
          description: >-
            Why nothing was sent. no_phone: no usable phone number. not_mobile:
            the number is a landline. no_consent: contact_by_whatsapp was false.
            opted_out: they've asked us to stop. stale: received more than 24
            hours ago. suppressed: suppress_conversation was set, or the number
            isn't on a dev key's allow-list. transaction_type_off: the agency
            hasn't switched Signal on for sales, or for lettings.
            whatsapp_not_connected: the agency's WhatsApp number isn't connected
            yet.
        greeting_sent_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Greeting Sent At
          description: When the greeting went, if it did.
      type: object
      required:
        - conversation
      title: ReceivedData
      description: What happened to the enquiry.
    SaleQualification:
      properties:
        kind:
          const: sale
          title: Kind
          description: >-
            `sale` or `letting`, the same as `transaction_type`. Says which
            fields follow.
        position:
          anyOf:
            - type: string
              enum:
                - cash
                - first_time_buyer
                - selling_mortgage
                - selling_cash_proceeds
                - selling_cash_available
                - renting_cash
                - renting_mortgage
                - living_with_family_cash
                - living_with_family_mortgage
                - other_mortgage
            - type: 'null'
          title: Position
          description: >-
            Their buying position. cash: cash buyer. first_time_buyer:
            first-time buyer. selling_mortgage: selling, using a mortgage.
            selling_cash_proceeds: selling, paying cash from the proceeds.
            selling_cash_available: selling, with cash available. renting_cash /
            renting_mortgage: renting, as a cash buyer / using a mortgage.
            living_with_family_cash / living_with_family_mortgage: living with
            family or friends, as a cash buyer / using a mortgage.
            other_mortgage: another living situation, using a mortgage.
        has_property_to_sell:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Property To Sell
          description: They have a home of their own to sell.
        on_market:
          anyOf:
            - type: boolean
            - type: 'null'
          title: On Market
          description: Their own home is already on the market.
        has_agent:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Agent
          description: An agent is already selling their own home.
        mortgage_status:
          anyOf:
            - type: string
              enum:
                - cash
                - aip_secured
                - no_aip
                - not_applicable
            - type: 'null'
          title: Mortgage Status
          description: >-
            cash: no mortgage needed. aip_secured: mortgage approval (or
            decision) in principle in place. no_aip: none yet. not_applicable:
            doesn't apply.
        wants_valuation:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Wants Valuation
          description: Asked for a valuation of the home they're selling.
        wants_mortgage_advice:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Wants Mortgage Advice
          description: Would like mortgage advice.
        viewing_availability:
          items:
            type: string
          type: array
          title: Viewing Availability
          description: When they can view, in their words.
        questions:
          items:
            type: string
          type: array
          title: Questions
          description: Questions the agency still needs to answer.
        summary:
          anyOf:
            - type: string
            - type: 'null'
          title: Summary
          description: A short plain-English summary of their answers.
      type: object
      required:
        - kind
      title: SaleQualification
      description: >-
        A buyer's answers to Signal's qualifying questions. New-homes buyers use
        the same shape.
    LettingQualification:
      properties:
        kind:
          const: letting
          title: Kind
          description: >-
            `sale` or `letting`, the same as `transaction_type`. Says which
            fields follow.
        occupants:
          items:
            type: string
          type: array
          title: Occupants
          description: Names of everyone who'd live there.
        occupant_count:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Occupant Count
          description: How many people would live there.
        employment_status:
          anyOf:
            - type: string
              enum:
                - employed
                - self_employed
                - student
                - retired
                - other
            - type: 'null'
          title: Employment Status
          description: employed, self_employed, student, retired or other.
        household_income_annual:
          anyOf:
            - $ref: '#/components/schemas/Money'
            - type: 'null'
          description: Total household income a year.
        move_in_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Move In Date
          description: When they want to move in.
        tenancy_length_months:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Tenancy Length Months
          description: How long they want to rent for.
        has_pets:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Pets
          description: Whether they have pets.
        pets_details:
          anyOf:
            - type: string
            - type: 'null'
          title: Pets Details
          description: What pets they have.
        has_smokers:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Smokers
          description: Whether anyone who'd live there smokes.
        viewing_availability:
          items:
            type: string
          type: array
          title: Viewing Availability
          description: When they can view, in their words.
        summary:
          anyOf:
            - type: string
            - type: 'null'
          title: Summary
          description: A short plain-English summary of their answers.
      type: object
      required:
        - kind
      title: LettingQualification
      description: A prospective tenant's answers to Signal's qualifying questions.
    GoneQuietData:
      properties:
        last_message_at:
          type: string
          format: date-time
          title: Last Message At
          description: Their last message, or our last if they never replied.
        ever_replied:
          type: boolean
          title: Ever Replied
          description: Whether they replied at least once.
      type: object
      required:
        - last_message_at
        - ever_replied
      title: GoneQuietData
      description: When they went quiet.
    OptedOutData:
      properties:
        opted_out_at:
          type: string
          format: date-time
          title: Opted Out At
          description: When they asked us to stop.
        keyword:
          anyOf:
            - type: string
            - type: 'null'
          title: Keyword
          description: The word they used, e.g. STOP. WhatsApp from Signal only.
      type: object
      required:
        - opted_out_at
      title: OptedOutData
      description: When and how they opted out.
    AskedForPersonData:
      properties:
        asked_at:
          type: string
          format: date-time
          title: Asked At
          description: When they asked for a person.
      type: object
      required:
        - asked_at
      title: AskedForPersonData
      description: When they asked.
    CantMakeItData:
      properties:
        answered_at:
          type: string
          format: date-time
          title: Answered At
          description: When they said they can't make it.
      type: object
      required:
        - answered_at
      title: CantMakeItData
      description: When they answered.
    SaleFeedback:
      properties:
        complete:
          type: boolean
          title: Complete
          description: >-
            False when the conversation ended before every question was
            answered.
        liked:
          items:
            type: string
          type: array
          title: Liked
          description: What they liked, in short phrases.
        disliked:
          items:
            type: string
          type: array
          title: Disliked
          description: What they didn't like, in short phrases.
        concerns:
          items:
            type: string
          type: array
          title: Concerns
          description: Worries they raised, e.g. about condition or price.
        wants_second_viewing:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Wants Second Viewing
          description: Whether they want to view it again.
        second_viewing_availability:
          anyOf:
            - type: string
            - type: 'null'
          title: Second Viewing Availability
          description: When they could come back, in their words.
        second_viewing_companions:
          anyOf:
            - type: string
            - type: 'null'
          title: Second Viewing Companions
          description: Who they'd bring to a second viewing.
        interested_in_similar:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Interested In Similar
          description: Would like to hear about similar properties.
        sentiment:
          anyOf:
            - type: string
              enum:
                - positive
                - neutral
                - negative
            - type: 'null'
          title: Sentiment
          description: Signal's reading of their overall tone.
        summary:
          anyOf:
            - type: string
            - type: 'null'
          title: Summary
          description: A short plain-English summary of what they said.
        kind:
          const: sale
          title: Kind
          description: >-
            `sale` or `letting`, the same as `transaction_type`. Says which
            fields follow.
        ready_to_offer:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Ready To Offer
          description: Said they're ready to make an offer.
        offer_amount:
          anyOf:
            - $ref: '#/components/schemas/Money'
            - type: 'null'
          description: The figure, if they gave one.
      type: object
      required:
        - complete
        - kind
      title: SaleFeedback
      description: What the person said after a sale or new-homes viewing.
    LettingFeedback:
      properties:
        complete:
          type: boolean
          title: Complete
          description: >-
            False when the conversation ended before every question was
            answered.
        liked:
          items:
            type: string
          type: array
          title: Liked
          description: What they liked, in short phrases.
        disliked:
          items:
            type: string
          type: array
          title: Disliked
          description: What they didn't like, in short phrases.
        concerns:
          items:
            type: string
          type: array
          title: Concerns
          description: Worries they raised, e.g. about condition or price.
        wants_second_viewing:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Wants Second Viewing
          description: Whether they want to view it again.
        second_viewing_availability:
          anyOf:
            - type: string
            - type: 'null'
          title: Second Viewing Availability
          description: When they could come back, in their words.
        second_viewing_companions:
          anyOf:
            - type: string
            - type: 'null'
          title: Second Viewing Companions
          description: Who they'd bring to a second viewing.
        interested_in_similar:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Interested In Similar
          description: Would like to hear about similar properties.
        sentiment:
          anyOf:
            - type: string
              enum:
                - positive
                - neutral
                - negative
            - type: 'null'
          title: Sentiment
          description: Signal's reading of their overall tone.
        summary:
          anyOf:
            - type: string
            - type: 'null'
          title: Summary
          description: A short plain-English summary of what they said.
        kind:
          const: letting
          title: Kind
          description: >-
            `sale` or `letting`, the same as `transaction_type`. Says which
            fields follow.
        wants_to_apply:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Wants To Apply
          description: Would like to apply for the tenancy.
        preferred_move_in_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Preferred Move In Date
          description: When they'd like to move in.
      type: object
      required:
        - complete
        - kind
      title: LettingFeedback
      description: What the person said after a letting viewing.
    NoteData:
      properties:
        about:
          type: string
          enum:
            - contact
            - viewing
            - property
          title: About
          description: >-
            Which of your records it belongs on: contact (contact_external_id /
            contact_id), viewing (viewing_external_id / viewing_id) or property
            (property.ref).
        text:
          type: string
          title: Text
          description: Ready to paste into your notes.
      type: object
      required:
        - about
        - text
      title: NoteData
      description: A note to add to your record.
    ShowhomeBookingData:
      properties:
        starts_at:
          type: string
          format: date-time
          title: Starts At
          description: When the show-home visit starts.
        ends_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Ends At
          description: When it ends, if known.
        cancelled_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Cancelled Reason
          description: Why it was cancelled, on booking_cancelled.
      type: object
      required:
        - starts_at
      title: ShowhomeBookingData
      description: A self-serve show-home booking made in Signal.
    ShowhomeVisitData:
      properties:
        visit_id:
          type: string
          format: uuid
          title: Visit Id
          description: >-
            Signal's id for the visit. A visit can arrive twice: at check-in,
            then again with feedback.
        visited_at:
          type: string
          format: date-time
          title: Visited At
          description: When they visited.
        feedback_summary:
          anyOf:
            - type: string
            - type: 'null'
          title: Feedback Summary
          description: What they said about the visit, if they gave feedback.
      type: object
      required:
        - visit_id
        - visited_at
      title: ShowhomeVisitData
      description: A visit recorded at the show home.
    InterestData:
      properties:
        registered_at:
          type: string
          format: date-time
          title: Registered At
          description: When they registered their interest.
      type: object
      required:
        - registered_at
      title: InterestData
      description: When they registered.
    EmptyData:
      properties: {}
      type: object
      title: EmptyData
      description: No data.
    DevelopmentRef:
      properties:
        ref:
          type: string
          maxLength: 128
          minLength: 1
          title: Ref
          description: >-
            Your development reference. Send the development first: an unknown
            one is a 422.
        name:
          anyOf:
            - type: string
              maxLength: 200
              minLength: 1
            - type: 'null'
          title: Name
          description: The development's name.
      type: object
      required:
        - ref
      title: DevelopmentRef
      description: A new-homes development, by your reference.
    Money:
      properties:
        amount:
          type: integer
          minimum: 0
          title: Amount
          description: >-
            Minor units: €395,000 is 39500000. A decimal point is refused,
            because it usually means whole euros or pounds were sent.
        currency:
          type: string
          enum:
            - EUR
            - GBP
          title: Currency
          description: EUR or GBP.
      type: object
      required:
        - amount
        - currency
      title: Money
      description: An amount in whole minor units (cents or pence).
  securitySchemes:
    AgencyKey:
      type: http
      description: >-
        The agency's secret key, sent as `Authorization: Bearer <key>`. One key
        per agency.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.