Skip to content

Instantly share code, notes, and snippets.

@januszm
Created May 23, 2024 11:52
Show Gist options
  • Save januszm/eb938c016f357cee8f1e15ae574c02d3 to your computer and use it in GitHub Desktop.
Save januszm/eb938c016f357cee8f1e15ae574c02d3 to your computer and use it in GitHub Desktop.
openapi: 3.0.1
info:
title: Webhooks API
version: '1.0'
description: API documentation for handling webhooks.
paths:
/api/webhooks/rently:
post:
summary: Handle Rently webhook events
description: Receives and processes webhook events from Rently.
requestBody:
required: true
content:
application/json:
schema:
type: object
description: The event data from Rently
properties:
type:
type: string
description: Type of event
email:
type: string
description: Email address associated with the event
other_properties:
type: object
additionalProperties: true
description: Additional event properties
responses:
'200':
description: Event received successfully
'400':
description: Failed to receive event
content:
application/json:
schema:
type: object
properties:
error:
type: string
/api/webhooks/behome247:
post:
summary: Handle Behome247 webhook events
description: Receives and processes webhook events from Behome247.
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
description: The event data from Behome247
properties:
event:
type: string
description: Type of event
webhook:
type: object
additionalProperties: true
description: The webhook data
responses:
'200':
description: Event received successfully
/api/webhooks/zillow:
post:
summary: Handle Zillow webhook events
description: Receives and processes webhook events from Zillow.
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
description: The event data from Zillow
properties:
listingId:
type: string
description: ID of the listing
name:
type: string
description: Name of the lead
email:
type: string
description: Email address of the lead
message:
type: string
description: Message from the lead
leadType:
type: string
description: Type of lead
responses:
'200':
description: Event received successfully
'400':
description: Input is missing parameters
content:
application/json:
schema:
type: object
properties:
error:
type: string
/api/webhooks/leads/redfin:
post:
summary: Handle Redfin webhook events
description: Receives and processes webhook events from Redfin.
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
description: The event data from Redfin
properties:
listingId:
type: string
description: ID of the listing
name:
type: string
description: Name of the lead
email:
type: string
description: Email address of the lead
phone:
type: string
description: Phone number of the lead
moveInDate:
type: string
description: Desired move-in date
message:
type: string
description: Message from the lead
responses:
'201':
description: Event received successfully
'400':
description: Input is missing parameters
content:
application/json:
schema:
type: object
properties:
error:
type: string
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment