{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/webhooks/webhooks.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Event Types","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"event-types","__idx":0},"children":["Event Types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Complete list of webhook events available in iClosed.io and their payload structures."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"available-webhook-events","__idx":1},"children":["Available Webhook Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["iClosed.io provides a comprehensive set of webhook events that allow you to stay informed about important changes in your account. Each event type has a unique identifier and includes relevant data in the payload."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"event-categories","__idx":2},"children":["Event Categories"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"contact-events","__idx":3},"children":["Contact Events"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event ID"},"children":["Event ID"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["newContactCreated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Triggered when a new contact is created"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contactDetailChanged"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Triggered when contact information is updated"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contactByStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Triggered when a contact’s status changes (for example after a call is booked); ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hookType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"contactByStatus\""]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"call-events","__idx":4},"children":["Call Events"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event ID"},"children":["Event ID"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["newCallScheduled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Triggered when a new call is scheduled"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callCancelled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Triggered when a call is cancelled"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callRescheduled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Triggered when a call is rescheduled"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"call-outcome-events","__idx":5},"children":["Call Outcome Events"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event ID"},"children":["Event ID"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callOutcome"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Triggered when a call outcome is added"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"event-payload-structure","__idx":6},"children":["Event Payload Structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each webhook event type has its own specific payload structure. The HTTP body is a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["single JSON object"]}," (not a JSON array wrapper)."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"hookType\": \"Event type description\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"available-event-types","__idx":7},"children":["Available Event Types"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"contact-created--newcontactcreated-","__idx":8},"children":["Contact Created (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["newContactCreated"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Triggered when a new contact is created in your iClosed.io account through any channel (form submission, manual creation, API, etc.)."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payload Structure:"]}," Complete contact object including personal details, event information, tracking data, questions and answers, and any associated calls."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Fields:"]}," Contact ID, name, email, phone, status, event details, tracking parameters, form responses, and call information."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use Cases:"]}," CRM synchronization, lead tracking, customer onboarding workflows, marketing attribution."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"contact-updated--contactdetailchanged-","__idx":9},"children":["Contact Updated (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contactDetailChanged"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Triggered when an existing contact's information is modified in your iClosed.io account."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payload Structure:"]}," Complete updated contact object with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updatedAttributes"]}," field showing what specifically changed, plus all current contact data."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Fields:"]}," All contact fields plus ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updatedAttributes"]}," array, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updatedAt"]}," timestamp, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hookType"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Contact updated\""]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use Cases:"]}," CRM updates, data validation, audit trails, workflow triggers, analytics tracking."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"contact-by-status--contactbystatus-","__idx":10},"children":["Contact by status (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contactByStatus"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Triggered when a contact’s ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["status"]}," changes in a way your workspace tracks for webhooks (for example when they move into a call-booked state). The payload is the same general ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["contact"]}," shape as other contact webhooks, including ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["latestCall"]}," when a call is associated, plus ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updatedAttributes"]}," describing what changed."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payload Structure:"]}," Contact object with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["questionsAndAnswers"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["event"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tracking"]},", optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["latestCall"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataIntelligence"]}," blocks."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Fields:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updatedAttributes"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hookType"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"contactByStatus\""]},", and when present ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["latestCall"]}," for the scheduled call tied to the transition."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use Cases:"]}," CRM stage automation, routing by pipeline status, alerting when a lead books a strategy call."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"call-booked--newcallscheduled-","__idx":11},"children":["Call Booked (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["newCallScheduled"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Triggered when a call is successfully scheduled and booked in your iClosed.io account."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payload Structure:"]}," Event type configuration, call instance details, invitee information, scheduling data, and tracking information."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Fields:"]}," Event type details, call UUID, assigned team member, start/end times, invitee details, booking form responses, and tracking data."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use Cases:"]}," Calendar synchronization, team notifications, CRM integration, analytics tracking, workflow automation."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"call-cancelled--callcancelled-","__idx":12},"children":["Call Cancelled (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callCancelled"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Triggered when a previously booked call is cancelled by either the invitee or the host."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payload Structure:"]}," Complete call information with cancellation details, who cancelled, when, and the reason for cancellation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Fields:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["event.canceled: true"]}," plus cancellation metadata (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["canceler_name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancel_reason"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["canceled_at"]},"); ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invitee"]}," may still carry cancellation fields with mixed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["canceled"]}," flags—inspect the sample payload for your integration."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use Cases:"]}," Calendar management, team notifications, CRM updates, follow-up automation, resource management."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"call-rescheduled--callrescheduled-","__idx":13},"children":["Call Rescheduled (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callRescheduled"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Triggered when a call is rescheduled to a new time in your iClosed.io account."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payload Structure:"]}," Call information with new timing, original timing (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["old_start_time"]},"), and rescheduling details."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Fields:"]}," All call details plus ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["old_start_time"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is_reschedule: true"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reschedule_reason"]}," (if provided)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use Cases:"]}," Calendar updates, team notifications, customer communication, resource management, workflow adjustments."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"outcome-added--calloutcome-","__idx":14},"children":["Outcome Added (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callOutcome"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Triggered when a call outcome is recorded after a call is completed in your iClosed.io account."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payload Structure:"]}," Complete call outcome data including contact information, call details, outcome type, deal information, and transaction details."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Fields:"]}," Call UUID, contact details, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callOutcome"]}," type, deal value, product name, transaction details, and outcome notes."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use Cases:"]}," Sales tracking, CRM updates, commission calculations, analytics, lead scoring updates, follow-up automation."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"detailed-documentation","__idx":15},"children":["Detailed Documentation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For comprehensive information about each webhook event type, including complete payload examples, field descriptions, and implementation details, see the individual documentation pages:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Contact Created"]}," – Complete guide to contact creation events"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Contact Updated"]}," – Detailed contact update event documentation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Call Booked"]}," – Comprehensive call booking event guide"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Call Cancelled"]}," – Complete call cancellation event documentation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Call Rescheduled"]}," – Detailed call rescheduling event guide"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Outcome Added"]}," – Comprehensive call outcome event documentation"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each detailed page includes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Complete JSON payload examples"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Field-by-field explanations"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use cases and best practices"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Response requirements"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Implementation guidelines"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"subscribing-to-events","__idx":16},"children":["Subscribing to Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When creating a webhook, specify which events you want to receive by including their IDs and names in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["triggers"]}," array:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"url\": \"https://your-app.com/webhooks\",\n  \"isActive\": true,\n  \"triggers\": [\n    {\n      \"id\": \"newContactCreated\",\n      \"name\": \"Contact created\"\n    },\n    {\n      \"id\": \"contactByStatus\",\n      \"name\": \"Contact by status\"\n    },\n    {\n      \"id\": \"newCallScheduled\",\n      \"name\": \"Call booked\"\n    },\n    {\n      \"id\": \"callOutcome\",\n      \"name\": \"Outcome added\"\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"valid-trigger-combinations","__idx":17},"children":["Valid Trigger Combinations"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Trigger ID"},"children":["Trigger ID"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Trigger Name"},"children":["Trigger Name"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["newContactCreated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact created"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contactDetailChanged"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact updated"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contactByStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact by status"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["newCallScheduled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Call booked"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callCancelled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Call cancelled"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callOutcome"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Outcome added"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callRescheduled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Call rescheduled"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"event-reliability","__idx":18},"children":["Event Reliability"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Real-time Delivery:"]}," Events are delivered immediately when they occur"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Retry Logic:"]}," Failed deliveries are retried with exponential backoff"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Duplicate Handling:"]}," Your endpoint should handle potential duplicate events"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response Time:"]}," Respond with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2xx"]}," status codes within 5 seconds"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"best-practices","__idx":19},"children":["Best Practices"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Idempotency"]}," – Design your webhook handlers to handle duplicate events safely"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Quick Response"]}," – Respond with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2xx"]}," status codes within 5 seconds to avoid retries"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Error Handling"]}," – Log failed events for debugging and monitoring"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Data Validation"]}," – Always validate the webhook payload structure"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Rate Limiting"]}," – Be prepared for high event volumes during peak times"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Monitoring"]}," – Set up alerts for webhook failures and response times"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Testing"]}," – Test your webhook endpoints with sample payloads before going live"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"getting-started","__idx":20},"children":["Getting Started"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Choose Events"]}," – Select the events you want to receive based on your use case"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Webhook"]}," – Use the webhook management API to create your subscription"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Implement Handler"]}," – Build your webhook endpoint to process the events"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Test"]}," – Verify your implementation with test events"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Monitor"]}," – Set up monitoring and alerting for your webhook performance"]}]}]},"headings":[{"value":"Event Types","id":"event-types","depth":1},{"value":"Available Webhook Events","id":"available-webhook-events","depth":2},{"value":"Event Categories","id":"event-categories","depth":2},{"value":"Contact Events","id":"contact-events","depth":3},{"value":"Call Events","id":"call-events","depth":3},{"value":"Call Outcome Events","id":"call-outcome-events","depth":3},{"value":"Event Payload Structure","id":"event-payload-structure","depth":2},{"value":"Available Event Types","id":"available-event-types","depth":2},{"value":"Contact Created ( newContactCreated )","id":"contact-created--newcontactcreated-","depth":3},{"value":"Contact Updated ( contactDetailChanged )","id":"contact-updated--contactdetailchanged-","depth":3},{"value":"Contact by status ( contactByStatus )","id":"contact-by-status--contactbystatus-","depth":3},{"value":"Call Booked ( newCallScheduled )","id":"call-booked--newcallscheduled-","depth":3},{"value":"Call Cancelled ( callCancelled )","id":"call-cancelled--callcancelled-","depth":3},{"value":"Call Rescheduled ( callRescheduled )","id":"call-rescheduled--callrescheduled-","depth":3},{"value":"Outcome Added ( callOutcome )","id":"outcome-added--calloutcome-","depth":3},{"value":"Detailed Documentation","id":"detailed-documentation","depth":2},{"value":"Subscribing to Events","id":"subscribing-to-events","depth":2},{"value":"Valid Trigger Combinations","id":"valid-trigger-combinations","depth":3},{"value":"Event Reliability","id":"event-reliability","depth":2},{"value":"Best Practices","id":"best-practices","depth":2},{"value":"Getting Started","id":"getting-started","depth":2}],"frontmatter":{"sidebar":{"path":"../webhooks.sidebars.yaml"},"seo":{"title":"Event Types"}},"lastModified":"2026-04-13T09:44:55.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/webhooks/webhooks_event_types/event-types","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}