Webhooks Overview

A webhook enables Funnel to push real-time notifications to your application. When an event occurs, Funnel will attempt to make a POST request with JSON body to any applicable configured webhooks. This request will be considered successful with any 2XX or 3XX status code that returns within 5 seconds. If we receive any other response or the request exceeds the timeout, it will be considered a failure. Funnel will retry sending the event 3 times, for a total of 4 attempts before considering the event publish a failure.

Webhook Configuration

Currently, the Funnel team needs to configure webhooks, so please reach out to your account manager or via Funnel Support to configure webhooks.

Webhook Payload

• id String/UUID A unique identifier for this event
• event String The type of event
• timestamp String/ISOTimestamp The timestamp when the event occurred
• data JSON The content of the event, varies by event type

Example Webhook

{
  "id": "3eb29a92-e480-40ee-9a9f-61fff5e3f3d5",
  "event": "lease.move_in_canceled",
  "timestamp": "2023-03-11T14:23:56.010+00:00",
  "data": {
    "move_in_date": "2023-03-11",
    "pms_identifier": "t0000000",
    "community_pms_identifier": "123"
  }
}

Events

• Lease Events
  • lease.move_in
  • lease.move_in_canceled