Skip to main content

Message Send Success

Overview

·Event key:
message.send_success

This event enables real-time confirmation of successful message delivery to renters via email or SMS. Use it to track communication delivery status, update message logs, trigger follow-up workflows, maintain delivery analytics, and ensure your systems reflect accurate communication states.

When This Event Triggers

This event fires when an outbound message (SMS or email) sent through the Partner API is successfully delivered. This event specifically tracks messages sent via the "Household Communication" feature, which allows external systems to send messages to residents through Funnel's communication platform. The event fires in the following scenarios:

  • SMS Successfully Delivered — When a text message sent via the Partner API is confirmed as delivered by Twilio (the SMS provider). The system receives a status callback from Twilio indicating the message was successfully delivered to the recipient's phone.
  • Email Successfully Sent — When an email sent via the Partner API is confirmed as sent through Nylas (the email provider). The system receives a webhook notification from Nylas confirming the outbound email was processed.

Important notes about this event:

  • This event only fires for messages created through the Partner API's Household Communication endpoint. Messages sent directly by leasing agents through the CRM interface do not trigger this webhook.
  • For SMS messages, the event fires when Twilio confirms delivery (not just when the message is sent).
  • For emails, the event fires when Nylas confirms the message was sent.

The event payload includes:

  • The internal message ID
  • The renter (client) ID who received the message
  • The renter person ID (the specific person on the client record)
  • The PMS identifier for the renter (if available)
  • Either the phone number (for SMS) or email address (for email) that received the message

This event is useful for external systems that send messages through the Partner API and need confirmation that their messages were successfully delivered to residents.

Event Payload

Example payloadJSON200 · application/json
{
"id": "8cc87045-aaaa-4a16-a882-454044e6762a",
"event": "message.send_success",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
  "message_id": 12345,
  "renter_id": 67890,
  "renter_person_id": 54321,
  "pms_identifier": "t1234",
  "phone": "+1234567890",
  "email": "renter@example.com"
}
}