Skip to main content

Webhook Requirements

Your endpoint must:
  1. Accept POST requests
  2. Respond within 15 seconds
  3. Verify the signature using the provided Signing Secret
See Svix Verification Guide for implementation details.

Event Types

Event TypeDescription
sms.respondResponse to an SMS message
email.respondResponse to an email message
web_chat.respondResponse to a web chat message

Example Webhook Payload

{
  "event_type": "web_chat.respond",
  "message_id": "550e8400-e29b-41d4-a716-446655440000",
  "body": {
    "message_id": "msg_response_123456",
    "conversation_id": "conv_abc123",
    "sender_name": "Travtus Assistant",
    "message_text": "Thank you for your inquiry! The 2-bedroom unit is still available. Would you like to schedule a tour?",
    "channel": "website",
    "company_id": "company_789",
    "sender_external_ref": "bot_travtus_ai",
    "human_handover_ind": false,
    "portfolio_external_ref": "property_oak_towers"
  }
}

Payload Fields

FieldTypeDescription
event_typestringWebhook event name
message_idstringSvix-assigned message ID
body.message_idstringOriginal message identifier
body.conversation_idstringConversation thread ID
body.sender_namestringName of sender
body.message_textstringAI-generated response text
body.channelstring"sms", "email", or "website"
body.company_idstringIdentifier for company
body.sender_external_refstringExternal reference for sender
body.human_handover_indbooleanTrue if handover to human suggested
body.portfolio_external_refstringExternal property or portfolio ref

Signature Verification

Verify all webhook requests using your Signing Secret.
Refer to Svix Docs for language-specific SDK examples.

Response Codes

StatusMeaning
2xxAcknowledged successfully
4xxInvalid request or signature
5xxTemporary issue (Svix retries automatically)

Support

For webhook delivery monitoring or signature troubleshooting:
Email: [email protected]