Introduction
Integrating your system with XILO’s API offers a streamlined process for managing form submissions and enhancing data flow between your platform, XILO, and your other software systems. This guide details the steps necessary to implement XILO’s API, from constructing the form to managing submissions and handling integrations. Our team, including your customer success manager, will support you through every step, ensuring a smooth integration process.
Step 1: Constructing the Form
The first step involves building out a form which will act as the API schema. This form is constructed based on specific requirements that you provide, including:
Sections: Categories such as Drivers, Vehicles, Property, and Applicants.
Fields: Information details like First Name, Last Name, and Dwelling Amount.
Data Types / Options: Types of data such as Text, Number, or selections like Male / Female.
Our team will use these details to construct a form that meets your exact needs.
Step 2: API Token and Documentation
Once the form is constructed, we will provide your team with an API token. This token is essential for authenticating your requests to our system. You can find detailed documentation on how to utilize our API at workflows-api.xilo.io/swagger. This documentation will help you understand how to make API calls and manage data correctly.
Step 3: Posting a Submission
To POST a submission, your team will need to:
Follow the schema format: Ensure that the data submitted matches the schema format and data types that were initially provided during the form construction.
Include a metadata object: This should contain high-level client record details and any integrations that you wish to trigger automatically.
It’s important to reference the FormView if there’s any confusion, as it represents the form itself in a more detailed schema.
Step 4: Handling Integrations
Integrations, such as auto-firing specific workflows based on the form data submitted, will be set up according to your requests. Make sure to communicate your integration needs clearly so that we can map these accurately to your form.
Step 5: Monitoring and Troubleshooting
All submission successes and failures are logged within the XILO Dashboard, which you can access as an administrator. If submissions fail, it is typically due to discrepancies between the data provided and the form schema. Our engineers will assist you in troubleshooting these issues to ensure smooth operation.
Step 6: Using XAI Auto-Fill
If you opt to use XILO’s XAI Auto-Fill:
Chrome Extension: Your team will need to download and set up a Chrome extension following our setup guide. Your customer success manager will support you through this setup process.
Lead Management: Once integrated, any leads posted to our API that are assigned to an agent will appear in their Chrome extension for immediate use.
Step 7: Integrating with Third-Party Systems
For those using third-party systems like Salesforce, leads can be assigned by passing their Salesforce ID. This flexibility ensures that XILO can integrate smoothly with your existing systems.
Conclusion
Our goal is to make the integration process as straightforward and efficient as possible. Your customer success manager, alongside our service team, will guide you through each step—from creating forms and managing integrations to training your team and troubleshooting any issues. By following these steps, you'll be well on your way to leveraging XILO’s capabilities to enhance your operational efficiency and data management.