Integrations
      Back to home
      1. Solo Help Center
      2. Integrations

      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 is an example of what that will look like in Solo

      • Contract Requested: Docs are requested for a customer.

        • Here 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 is an example of what that will look like in Solo

      • Customer Updated: An existing customer is updated.

        • Here is an example of what that will look like in Solo

      • Customer Status Changed: An existing customer's status is updated.

        • Here is an example of what that will look like in Solo

      • Proposal Requested: A new proposal is requested on an existing customer.

        • Here is an example of what that will look like in Solo

      • Proposal Sent: A new proposal is delivered after being requested.

        • Here is an example of what that will look like in Solo

      • Proposal Saved: An existing proposal is saved.

        • Here is an example of what that will look like in Solo

      • Proposal Sold: An existing proposal is marked as "sold".

        • Here 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 is an example of what that will look like in Solo

      • Credit Ran: Credit is run in the proposal for a customer. 

        • Here 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.