Skip to main content
The webchat.contactForm.submitted webhook event is triggered whenever a visitor submits the contact form inside a webchat session. This fires before the session is converted into a lead and lets you react to captured contact information immediately.

​
Payload

{
  "event": "webchat.contactForm.submitted",
  "data": {
    "sessionId": "550e8400-e29b-41d4-a716-446655440000",
    "orgId": "org-abc123",
    "profile": "Default Profile",
    "origin": "https://example.com/pricing",
    "firstName": "Jane",
    "lastName": "Doe",
    "phone": "+12025550189",
    "email": "jane@example.com",
    "conversionReady": true
  },
  "timestamp": "2024-01-15T14:30:00Z"
}

​
Properties

PropertyTypeDescription
eventstringThe webhook event type (webchat.contactForm.submitted).
data.sessionIdstringThe unique identifier for the webchat session.
data.orgIdstringThe Apten organization ID that owns the session.
data.profilestringThe name of the webchat profile that handled the session.
data.originstringThe URL of the page where the webchat widget was opened. Only included if set.
data.firstNamestringThe visitor’s first name. Only included if provided.
data.lastNamestringThe visitor’s last name. Only included if provided.
data.phonestringThe visitor’s phone number. Only included if provided.
data.emailstringThe visitor’s email address. Only included if provided.
data.conversionReadybooleanWhether the submitted information is sufficient to convert the session into a lead.
timestampstringThe ISO 8601 timestamp when the webhook was sent.