openapi: 3.1.0 x-stoplight: id: w715rp9if6gcp info: title: Street-Webhooks version: '1.0' servers:

• url: 'http://localhost:3000' paths: {} webhooks: property.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object x-stoplight: id: 032pge821b182 properties: eventType: type: string x-stoplight: id: itdqrs182s6b8 enum: - property.created description: The property has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully property.updated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object x-stoplight: id: 7usgwou43nk46 properties: eventType: type: string x-stoplight: id: 2iyqx5urd1f05 enum: - property.updated description: The property has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully property.sales.price-changed: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - property.sales.price-changed description: The sales property price has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully property.lettings.price-changed: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - property.lettings.price-changed description: The lettings property price has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully property.status-changed: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - property.status-changed description: The property status has been changed responses: '200': description: >- Return a 200 status to indicate that the data was received successfully property.photos-updated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - property.photos-updated description: The property photos have been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully property.archived: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - property.archived description: The property has been archived responses: '200': description: >- Return a 200 status to indicate that the data was received successfully property.unarchived: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - property.unarchived description: The property has been unarchived responses: '200': description: >- Return a 200 status to indicate that the data was received successfully applicant.sales.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object x-stoplight: id: 065su0p1dbd4z properties: eventType: type: string x-stoplight: id: 00isnfdjnp93d enum: - applicant.sales.created description: The sales applicant has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully applicant.sales.updated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object x-stoplight: id: fy8lg3gzpiwqh properties: eventType: type: string x-stoplight: id: s0ndhlmsnfoyp enum: - applicant.sales.updated description: The sales applicant has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully applicant.lettings.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object x-stoplight: id: 51uln62te7ahm properties: eventType: type: string x-stoplight: id: tncucnft8h4r7 enum: - applicant.lettings.created description: The lettings applicant has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully applicant.lettings.updated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object x-stoplight: id: 8rtdz462ckklr properties: eventType: type: string x-stoplight: id: e1f9enjfmrqt5 enum: - applicant.lettings.updated description: The lettings applicant has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully brand.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - brand.created description: The brand has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully brand.deleted: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - brand.deleted description: The brand has been deleted responses: '200': description: >- Return a 200 status to indicate that the data was received successfully brand.updated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - brand.updated description: The brand has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully branch.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - branch.created description: The branch has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully branch.deleted: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - branch.deleted description: The branch has been deleted responses: '200': description: >- Return a 200 status to indicate that the data was received successfully company.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - company.created description: The company has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully company.updated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - company.updated description: The company has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully viewing.booked: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - viewing.booked description: The viewing has been booked responses: '200': description: >- Return a 200 status to indicate that the data was received successfully viewing.rearranged: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - viewing.rearranged description: The viewing has been rearranged responses: '200': description: >- Return a 200 status to indicate that the data was received successfully viewing.confirmed: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - viewing.confirmed description: The viewing has been confirmed responses: '200': description: >- Return a 200 status to indicate that the data was received successfully viewing.cancelled: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - viewing.cancelled description: The viewing has been cancelled responses: '200': description: >- Return a 200 status to indicate that the data was received successfully viewing.completed: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - viewing.completed description: The viewing has been completed responses: '200': description: >- Return a 200 status to indicate that the data was received successfully valuation.booked: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - valuation.booked description: The valuation has been booked responses: '200': description: >- Return a 200 status to indicate that the data was received successfully valuation.rearranged: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - valuation.rearranged description: The valuation has been rearranged responses: '200': description: >- Return a 200 status to indicate that the data was received successfully valuation.cancelled: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - valuation.cancelled description: The valuation has been cancelled responses: '200': description: >- Return a 200 status to indicate that the data was received successfully valuation.instructed: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - valuation.instructed description: The valuation has been instructed responses: '200': description: >- Return a 200 status to indicate that the data was received successfully valuation.lost: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - valuation.lost description: The valuation has been lost responses: '200': description: >- Return a 200 status to indicate that the data was received successfully valuation.not-attended: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - valuation.not-attended description: The valuation was not attended responses: '200': description: >- Return a 200 status to indicate that the data was received successfully valuation.completed: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - valuation.completed description: The valuation has been completed responses: '200': description: >- Return a 200 status to indicate that the data was received successfully person.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - person.created description: The person has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully person.updated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - person.updated description: The person has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully enquiry.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - enquiry.created description: The enquiry has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully offer.sales.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - offer.sales.created description: The sales offer has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully offer.sales.updated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - offer.sales.updated description: The sales offer has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully offer.sales.accepted: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - offer.sales.confirmed description: The sales offer has been confirmed responses: '200': description: >- Return a 200 status to indicate that the data was received successfully offer.sales.rejected: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - offer.sales.cancelled description: The sales offer has been cancelled responses: '200': description: >- Return a 200 status to indicate that the data was received successfully offer.sales.withdrawn: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - offer.sales.withdrawn description: The sales offer has been withdrawn responses: '200': description: >- Return a 200 status to indicate that the data was received successfully offer.lettings.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - offer.lettings.created description: The lettings offer has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully offer.lettings.accepted: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - offer.lettings.accepted description: The lettings offer has been accepted responses: '200': description: >- Return a 200 status to indicate that the data was received successfully offer.lettings.rejected: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - offer.lettings.rejected description: The lettings offer has been rejected responses: '200': description: >- Return a 200 status to indicate that the data was received successfully tenancy.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - tenancy.created description: The tenancy has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully tenancy.updated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - tenancy.updated description: The tenancy has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully sale.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - sale.created description: The sale has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully sale.updated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - sale.updated description: The sale has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully sale.completed: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - sale.completed description: The sale has been completed responses: '200': description: >- Return a 200 status to indicate that the data was received successfully sale.exchanged: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - sale.exchanged description: The sale has been exchanged responses: '200': description: >- Return a 200 status to indicate that the data was received successfully sale.fallen-through: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - sale.fallen-though description: The sale has fallen through responses: '200': description: >- Return a 200 status to indicate that the data was received successfully listing.sales.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - listing.sales.created description: The sales listing has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully listing.sales.published: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - listing.sales.published description: The sales listing has been published responses: '200': description: >- Return a 200 status to indicate that the data was received successfully listing.sales.updated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - listing.sales.updated description: The sales listing has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully listing.sales.removed: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - listing.sales.removed description: The sales listing has been removed responses: '200': description: >- Return a 200 status to indicate that the data was received successfully listing.sales.withdrawn: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - listing.sales.withdrawn description: The sales listing has been withdrawn responses: '200': description: >- Return a 200 status to indicate that the data was received successfully listing.lettings.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - listing.lettings.created description: The lettings listing has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully listing.lettings.published: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - listing.lettings.published description: The lettings listing has been published responses: '200': description: >- Return a 200 status to indicate that the data was received successfully listing.lettings.updated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - listing.lettings.updated description: The lettings listing has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully listing.lettings.removed: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - listing.lettings.removed description: The lettings listing has been removed responses: '200': description: >- Return a 200 status to indicate that the data was received successfully listing.lettings.withdrawn: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - listing.lettings.withdrawn description: The lettings listing has been withdrawn responses: '200': description: >- Return a 200 status to indicate that the data was received successfully instruction.sales.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - instruction.sales.created description: The sales instruction has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully instruction.sales.updated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - instruction.sales.updated description: The sales instruction has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully instruction.sales.revoked: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - instruction.sales.revoked description: The sales instruction has been revoked responses: '200': description: >- Return a 200 status to indicate that the data was received successfully instruction.lettings.created: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - instruction.lettings.created description: The lettings instruction has been created responses: '200': description: >- Return a 200 status to indicate that the data was received successfully instruction.lettings.updated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - instruction.lettings.updated description: The lettings instruction has been updated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully instruction.lettings.revoked: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - instruction.lettings.revoked description: The lettings instruction has been revoked responses: '200': description: >- Return a 200 status to indicate that the data was received successfully inspection.cancelled: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - inspection.cancelled description: The inspection has been cancelled responses: '200': description: >- Return a 200 status to indicate that the data was received successfully inspection.completed: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - inspection.completed description: The inspection has been completed responses: '200': description: >- Return a 200 status to indicate that the data was received successfully inspection.confirmed: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - inspection.confirmed description: The inspection has been confirmed responses: '200': description: >- Return a 200 status to indicate that the data was received successfully inspection.deleted: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - inspection.deleted description: The inspection has been deleted responses: '200': description: >- Return a 200 status to indicate that the data was received successfully inspection.report-uploaded: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - inspection.report-uploaded description: The inspection report has been uploaded responses: '200': description: >- Return a 200 status to indicate that the data was received successfully inspection.scheduled: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - inspection.scheduled description: The inspection has been scheduled responses: '200': description: >- Return a 200 status to indicate that the data was received successfully esign-document.generated: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - esign-document.generated description: The E-Sign document has been generated responses: '200': description: >- Return a 200 status to indicate that the data was received successfully esign-document.sent: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - esign-document.sent description: The E-Sign document has been sent responses: '200': description: >- Return a 200 status to indicate that the data was received successfully esign-document.recipient-signed: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - esign-document.recipient-signed description: The E-Sign document has been recipient-signed responses: '200': description: >- Return a 200 status to indicate that the data was received successfully esign-document.completed: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - esign-document.completed description: The E-Sign document has been completed responses: '200': description: >- Return a 200 status to indicate that the data was received successfully esign-document.cancelled: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - esign-document.cancelled description: The E-Sign document has been cancelled responses: '200': description: >- Return a 200 status to indicate that the data was received successfully questionnaire-response.submitted: post: requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseWebhookModel' - type: object properties: eventType: type: string enum: - questionnaire-response.submitted description: The questionnaire response has been submitted responses: '200': description: >- Return a 200 status to indicate that the data was received successfully components: schemas: BaseWebhookModel: title: Base Webhook Model x-stoplight: id: x0wpm5ip1oxvk type: object properties: eventType: type: string x-stoplight: id: zxp4r2u6f06ff eventId: type: string x-stoplight: id: xofgmtqw6oz43 format: uuid payload: type: object x-stoplight: id: dk5aposltotas required: - entity_id properties: event_type: type: string entity_id: type: string x-stoplight: id: idiw7myk8vpyj format: uuid network_id: type: string format: uuid details: type: array required: - eventType - eventId - payload x-internal: true