--- title: API Trigger Events description: "This article covers API Trigger Events and where to find them id: number A unique identifier. company_id: number A reference to the associated company's unique identifier. [Can be found here in Solo]" --- [Skip to content](https://help.gosolo.io/api-trigger-events#main-content) [![Solo Black-1](https://help.gosolo.io/hubfs/Solo%20Black-1.svg)](https://help.gosolo.io/?hsLang=en) - [Solo Help Center](https://help.gosolo.io/) Open main navigation Close main navigation - [Solo Help Center](https://help.gosolo.io/) - [Go to Solo](https://phx.gosolo.io/) [Go to Solo](https://phx.gosolo.io/) How can we help? - There are no suggestions because the search field is empty. 1. [Solo Help Center](https://help.gosolo.io/?hsLang=en) 2. [Integrations & Partnerships](https://help.gosolo.io/integrations-partnerships?hsLang=en) 3. [API Documentation](https://help.gosolo.io/integrations-partnerships?hsLang=en#api-documentation) February 6, 2025 # API Trigger Events This article covers API Trigger Events and where to find them ### Structure 1. id: number A unique identifier. 2. company\_id: number A reference to the associated company's unique identifier. \[Can be found here in Solo\] 3. event: string A string to represent when the webhook should be triggered. The current supported events will trigger the webhook when: ### Events - Appointment Set: An appointment is set on a customer. - [Here](https://www.screencast.com/t/Nhp1EryUeeU) is an example of what that will look like in Solo - Contract Requested: Docs are requested for a customer. - [Here](https://www.screencast.com/t/suBJdRzO5) is an example of what that will look like in Solo - Contract Sent: Docs are sent for a customer. - This will trigger when the docusign packet provided by Solo is sent to the customer’s email - Contract Signed: Docs have been signed by a customer. - This will trigger when the customer has signed the docusign packet provided by Solo - Customer Created: A new customer is created. - [Here](https://www.screencast.com/t/4X0QU2mHK) is an example of what that will look like in Solo - Customer Updated: An existing customer is updated. - [Here](https://www.screencast.com/t/dcDch0lU) is an example of what that will look like in Solo - Customer Status Changed: An existing customer's status is updated. - [Here](https://www.screencast.com/t/9b7lI5dG) is an example of what that will look like in Solo - Proposal Requested: A new proposal is requested on an existing customer. - [Here](https://www.screencast.com/t/wUdl9SEB) is an example of what that will look like in Solo - Proposal Sent: A new proposal is delivered after being requested. - [Here](https://www.screencast.com/t/zqGG77tSm4av) is an example of what that will look like in Solo - Proposal Saved: An existing proposal is saved. - [Here](https://www.screencast.com/t/RVx9YknbR7H3) is an example of what that will look like in Solo - Proposal Sold: An existing proposal is marked as "sold". - [Here](https://www.screencast.com/t/SRaEEWJ4JdR1) is an example of what that will look like in Solo - Proposal Selected: An existing proposal is selected to be sold or to have docs requested. - [Here](https://www.screencast.com/t/eQ9SEA9sDd) is an example of what that will look like in Solo - Credit Ran: Credit is run in the proposal for a customer.  - [Here](https://www.screencast.com/t/bfqlKlMvOshs) is an example of what that will look like in Solo ### Definitions - url: string The full URL to be called (in other words, where the webhook will take the information to) by the webhook when it is triggered. - auth: object Any authorization required for the webhook's URL. The contents of the auth object change based on the type of authorization required. - [Getting Started with Solo](https://help.gosolo.io/getting-started-with-solo?hsLang=en) - [Users & Permissions](https://help.gosolo.io/users-permissions?hsLang=en#main-content) - [Your Account](https://help.gosolo.io/users-permissions?hsLang=en#your-account) - [Managing Users](https://help.gosolo.io/users-permissions?hsLang=en#managing-users) - [User Permissions](https://help.gosolo.io/users-permissions?hsLang=en#user-permissions) - [Customer Management](https://help.gosolo.io/customer-management?hsLang=en) - [Solo Studio](https://help.gosolo.io/solo-studio?hsLang=en#main-content) - [DirectDesign](https://help.gosolo.io/solo-studio?hsLang=en#directdesign) - [Proposals](https://help.gosolo.io/proposals?hsLang=en#main-content) - [Requesting a Proposal](https://help.gosolo.io/proposals?hsLang=en#requesting-a-proposal) - [Adjusting Your Proposals](https://help.gosolo.io/proposals?hsLang=en#adjusting-your-proposals) - [Sharing Proposals](https://help.gosolo.io/proposals?hsLang=en#sharing-proposals) - [Understanding the Proposal](https://help.gosolo.io/proposals?hsLang=en#understanding-the-proposal) - [Video Gallery](https://help.gosolo.io/proposals?hsLang=en#video-gallery) - [Roofing Proposals](https://help.gosolo.io/proposals?hsLang=en#roofing-proposals) - [Battery-Only Proposals](https://help.gosolo.io/proposals?hsLang=en#battery-only-proposals) - [Shade Reports](https://help.gosolo.io/proposals?hsLang=en#shade-reports) - [DXF](https://help.gosolo.io/proposals?hsLang=en#dxf) - [SoloSign](https://help.gosolo.io/solosign?hsLang=en#main-content) - [SoloSign+](https://help.gosolo.io/solosign?hsLang=en#solosign) - [SoloSign Self Service](https://help.gosolo.io/solosign?hsLang=en#solosign-self-service) - [General Owner Settings](https://help.gosolo.io/general-owner-settings?hsLang=en) - [MissionControl](https://help.gosolo.io/missioncontrol?hsLang=en#main-content) - [Finance Options](https://help.gosolo.io/missioncontrol?hsLang=en#finance-options) - [Modules](https://help.gosolo.io/missioncontrol?hsLang=en#modules) - [Inverters](https://help.gosolo.io/missioncontrol?hsLang=en#inverters) - [Optimizers](https://help.gosolo.io/missioncontrol?hsLang=en#optimizers) - [Batteries](https://help.gosolo.io/missioncontrol?hsLang=en#batteries) - [Proposal Theme](https://help.gosolo.io/missioncontrol?hsLang=en#proposal-theme) - [Adders](https://help.gosolo.io/missioncontrol?hsLang=en#adders) - [Company Pricing](https://help.gosolo.io/missioncontrol?hsLang=en#company-pricing) - [Design Preferences](https://help.gosolo.io/missioncontrol?hsLang=en#design-preferences) - [Shade Report](https://help.gosolo.io/missioncontrol?hsLang=en#shade-report) - [Lender Priority](https://help.gosolo.io/missioncontrol?hsLang=en#lender-priority) - [DXF](https://help.gosolo.io/missioncontrol?hsLang=en#dxf) - [Company Settings](https://help.gosolo.io/missioncontrol?hsLang=en#company-settings) - [Integrations & Partnerships](https://help.gosolo.io/integrations-partnerships?hsLang=en#main-content) - [API Documentation](https://help.gosolo.io/integrations-partnerships?hsLang=en#api-documentation) - [Webhooks](https://help.gosolo.io/integrations-partnerships?hsLang=en#webhooks) - [Palmetto LightReach](https://help.gosolo.io/integrations-partnerships?hsLang=en#palmetto-lightreach) - [GoodLeap](https://help.gosolo.io/integrations-partnerships?hsLang=en#goodleap) - [GoodLeap TPO](https://help.gosolo.io/integrations-partnerships?hsLang=en#goodleap-tpo) - [Sunlight Financial](https://help.gosolo.io/integrations-partnerships?hsLang=en#sunlight-financial) - [Sunlight SunSaver](https://help.gosolo.io/integrations-partnerships?hsLang=en#sunlight-sunsaver) - [Dividend](https://help.gosolo.io/integrations-partnerships?hsLang=en#dividend) - [Sungage](https://help.gosolo.io/integrations-partnerships?hsLang=en#sungage) - [Callpilot](https://help.gosolo.io/integrations-partnerships?hsLang=en#callpilot) - [Radicl](https://help.gosolo.io/integrations-partnerships?hsLang=en#radicl) - [Solar Insure](https://help.gosolo.io/integrations-partnerships?hsLang=en#solar-insure) - [Align Solar Protection](https://help.gosolo.io/integrations-partnerships?hsLang=en#align-solar-protection) - [Vivint](https://help.gosolo.io/integrations-partnerships?hsLang=en#vivint) - [Figure](https://help.gosolo.io/integrations-partnerships?hsLang=en#figure) - [Participate Energy](https://help.gosolo.io/integrations-partnerships?hsLang=en#participate-energy) - [SolarNexus](https://help.gosolo.io/integrations-partnerships?hsLang=en#solarnexus) - [What's New](https://help.gosolo.io/whats-new?hsLang=en) - [User Support](https://help.gosolo.io/user-support?hsLang=en#main-content) - [English Video Gallery](https://help.gosolo.io/user-support?hsLang=en#english-video-gallery) - [Spanish Video Gallery](https://help.gosolo.io/user-support?hsLang=en#spanish-video-gallery) [![Chill listening crop-3](https://help.gosolo.io/hubfs/Solo%20Black-2.svg "Chill listening crop-3")](https://gosolo.io) Copyright © 2025, Solo