Table of contents

1. Version information

2. Authentication

   1. OAuth2 authentication

3. Fields

4. Triggers

   1. Proposal triggers

      1. Proposal published
      2. Proposal accepted
      3. Proposal created
      4. Proposal lost
      5. Proposal revoked

   2. Client triggers

      1. Client created
      2. Client updated
      3. Client converted to customer

   3. Invoice triggers

      1. Invoice created
      2. Invoice updated
      3. Invoice finalized
      4. Invoice paid
      5. Invoice canceled

5. Actions

   1. Create business customer
   2. Create business prospect
   3. Create individual customer
   4. Create individual prospect

Version information

• Version: 3.0.0
• Platform Version: 15.15.0

Authentication

This integration uses OAuth2 for authentication. Here is how it is structured:

a. OAuth2 authentication

• Authorization Type: OAuth2

• Oauth2 Configuration:

  • Authorization URL: Accepts the client_id, state, redirect_uri, response_type, audience, and scope as parameters to the authorization URL
  • Get Access Token: A POST request is made to retrieve an access token, using code, client_id, client_secret, grant_type, and redirect_uri
  • Refresh Access Token: This refreshes the access token when expired
  • Scope: openid, profile, email, offline_access
  • Auto-refresh: Enabled

• Testing Authentication

  • URL: https://#{{process.env.API_BASE}}/v1/users/meta
  • Headers: Requires Authorization and X-ORG-ID headers
  • Params: Requires org_id

Fields

• org_id: Computed field, used in connection labeling

Triggers

The integration supports various triggers based on different events:

a. Proposal triggers

1. Proposal published

   • Description: Triggers when a proposal is published.

   • Key: proposal_published

   • Output description:

     • id: string

       • The unique identifier for the proposal. Example: "cbddb2fd-60b6-4c25-a69c-17fbde34a148".

     • name: string

       • The name or title of the proposal. Example: "Sample Proposal".

     • due_date: string (ISO 8601 format)

       • The date by which the proposal should be reviewed or completed. Example: "2021-12-31".

     • preview_url: string

       • A URL where the preview of the proposal can be accessed. Example: "<https://example.com/pm/proposals/preview/123>".

     • start_date: string (ISO 8601 format)

       • The starting date for the proposal activities or services. Example: "2021-12-01".

     • end_date: string (ISO 8601 format)

       • The completion date for the proposal activities or services. Example: "2021-12-31".

     • created_at: string (ISO 8601 format with timezone)

       • The date and time when the proposal was created. Example: "2024-09-05T11:06:00.910465+05:30".

     • published_at: string (ISO 8601 format with timezone)

       • The date and time when the proposal was published. Example: "2024-09-05T11:06:00.910465+05:30".

     • sent_at: string (optional)

       • The date and time when the proposal was sent to stakeholders. Empty if not yet sent. Example: "".

     • staff: array of objects

       • A list of staff members associated with the proposal.

       • name: string

         • The name of a staff member. Example: "John Doe".

       • email: string

         • The email address of the staff member. Example: "[email protected]".

     • signatory: array of objects

       • A list of client contacts who must sign the proposal.

       • name: string

         • The name of the signatory. Example: "Jane Doe".

       • email: string

         • The email address of the signatory. Example: "[email protected]".

       • url: string

         • A URL specific to the signatory for accessing the proposal. Example: "<https://example.com/shared/proposals/123>".

     • services: array of objects

       • The list of services included in the proposal.

       • name: string

         • The name of the service. Example: "Sample Service".

       • description: string

         • A brief description of the service. Example: "Sample Description".

       • pricing_method: string

         • The method used to price the service. Possible values include "fixed", "hourly", etc. Example: "fixed".

       • billing_type: string

         • Indicates the type of billing, whether one-time or recurring. Example: "one_time".

       • price: string (numeric value as string)

         • The base price of the service before tax. Example: "100".

       • tax: string (numeric value as string)

         • The amount of tax applied to the service price. Example: "10".

       • total: string (numeric value as string)

         • The total price including tax. Example: "110"

   • Sample data:

   {  
   "id": "cbddb2fd-60b6-4c25-a69c-17fbde34a148",  
   "name": "Sample Proposal",  
   "due_date": "2021-12-31",  
   "preview_url": "<https://example.com/pm/proposals/preview/123>",  
   "start_date": "2021-12-01",  
   "end_date": "2021-12-31",  
   "created_at": "2024-09-05T11:06:00.910465+05:30",  
   "published_at": "2024-09-05T11:06:00.910465+05:30",  
   "sent_at": "",  
   "staff": [  
   {  
   "name": "John Doe",  
   "email": "[email protected]"  
    }  
   ],  
   "signatory": [  
   {  
   "name": "Jane Doe",  
   "email": "[email protected]",  
   "url": "<https://example.com/shared/proposals/123>"  
    }  
   ],  
   "services": [  
   {  
   "name": "Sample Service",  
   "description": "Sample Description",  
   "pricing_method": "fixed",  
   "billing_type": "one_time",  
   "price": "100",  
   "tax": "10",  
   "total": "110"  
    }  
   ]  
   }
   

2. Proposal accepted

   • Description: Triggers when a proposal is accepted.

   • Key: proposal_accepted

   • Output description:

     • id: string

       • The unique identifier for the proposal. Example: "cbddb2fd-60b6-4c25-a69c-17fbde34a148".

     • name: string

       • The name or title of the proposal. Example: "Sample Proposal".

     • due_date: string (ISO 8601 format)

       • The date by which the proposal should be reviewed or completed. Example: "2021-12-31".

     • preview_url: string

       • A URL where the preview of the proposal can be accessed. Example: "<https://example.com/pm/proposals/preview/123>".

     • start_date: string (ISO 8601 format)

       • The starting date for the proposal activities or services. Example: "2021-12-01".

     • end_date: string (ISO 8601 format)

       • The completion date for the proposal activities or services. Example: "2021-12-31".

     • created_at: string (ISO 8601 format with timezone)

       • The date and time when the proposal was created. Example: "2024-09-05T11:06:00.910465+05:30".

     • published_at: string (ISO 8601 format with timezone)

       • The date and time when the proposal was published. Example: "2024-09-05T11:06:00.910465+05:30".

     • sent_at: string (optional)

       • The date and time when the proposal was sent to stakeholders. Empty if not yet sent. Example: "".

     • staff: array of objects

       • A list of staff members associated with the proposal.

       • name: string

         • The name of a staff member. Example: "John Doe".

       • email: string

         • The email address of the staff member. Example: "[email protected]".

     • signatory: array of objects

       • A list of client contacts who must sign the proposal.

       • name: string

         • The name of the signatory. Example: "Jane Doe".

       • email: string

         • The email address of the signatory. Example: "[email protected]".

       • url: string

         • A URL specific to the signatory for accessing the proposal. Example: "<https://example.com/shared/proposals/123>".

       • signed at: The date and time when this signatory signed the proposal. Example: "2024-09-05T11:06:00.910465+05:30"

     • services: array of objects

       • The list of services included in the proposal.

       • name: string

         • The name of the service. Example: "Sample Service".

       • description: string

         • A brief description of the service. Example: "Sample Description".

       • pricing_method: string

         • The method used to price the service. Possible values include "fixed", "hourly", etc. Example: "fixed".

       • billing_type: string

         • Indicates the type of billing, whether one-time or recurring. Example: "one_time".

       • price: string (numeric value as string)

         • The base price of the service before tax. Example: "100".

       • tax: string (numeric value as string)

         • The amount of tax applied to the service price. Example: "10".

       • total: string (numeric value as string)

         • The total price including tax. Example: "110"

   • Sample data:

     {  
     "id": "cbc80cc2-bed2-4a01-9649-2468c62ca5a7",  
     "name": "Sample Proposal",  
     "preview_url": "<https://example.com/pm/proposals/preview/123>",  
     "start_date": "2021-12-01",  
     "end_date": "2021-12-31",  
     "created_at": "2024-09-05T11:08:26.962764+05:30",  
     "published_at": "2024-09-05T11:08:26.962764+05:30",  
     "sent_at": "",  
     "staff": [  
     {  
     "name": "John Doe",  
     "email": "[email protected]"  
      }  
     ],  
     "signatory": [  
     {  
     "name": "Jane Doe",  
     "email": "[email protected]",  
     "url": "<https://example.com/shared/proposals/123>",  
     "signed_at": "2024-09-05T11:08:26.962764+05:30"  
      }  
     ],  
     "services": [  
     {  
     "name": "Sample Service",  
     "description": "Sample Description",  
     "pricing_method": "fixed",  
     "billing_type": "one_time",  
     "price": "100",  
     "tax": "10",  
     "total": "110"  
      }  
     ]  
     }
     

3. Proposal created

   • Description: Triggers when a proposal is created as draft.

   • Key: proposal_created

   • Output description:

     • id: string

       • The unique identifier for the proposal. Example: "cbddb2fd-60b6-4c25-a69c-17fbde34a148".

     • name: string

       • The name or title of the proposal. Example: "Sample Proposal".

     • due_date: string (ISO 8601 format)

       • The date by which the proposal should be reviewed or completed. Example: "2021-12-31".

     • preview_url: string

       • A URL where the preview of the proposal can be accessed. Example: "<https://example.com/pm/proposals/preview/123>".

     • start_date: string (ISO 8601 format)

       • The starting date for the proposal activities or services. Example: "2021-12-01".

     • end_date: string (ISO 8601 format)

       • The completion date for the proposal activities or services. Example: "2021-12-31".

     • created_at: string (ISO 8601 format with timezone)

       • The date and time when the proposal was created. Example: "2024-09-05T11:06:00.910465+05:30".

     • staff: array of objects

       • A list of staff members associated with the proposal.

       • name: string

         • The name of a staff member. Example: "John Doe".

       • email: string

         • The email address of the staff member. Example: "[email protected]".

     • signatory: array of objects

       • A list of client contacts who must sign the proposal.

       • name: string

         • The name of the signatory. Example: "Jane Doe".

       • email: string

         • The email address of the signatory. Example: "[email protected]".

       • url: string

         • A URL specific to the signatory for accessing the proposal. Example: "<https://example.com/shared/proposals/123>".

     • services: array of objects

       • The list of services included in the proposal.

       • name: string

         • The name of the service. Example: "Sample Service".

       • description: string

         • A brief description of the service. Example: "Sample Description".

       • pricing_method: string

         • The method used to price the service. Possible values include "fixed", "hourly", etc. Example: "fixed".

       • billing_type: string

         • Indicates the type of billing, whether one-time or recurring. Example: "one_time".

       • price: string (numeric value as string)

         • The base price of the service before tax. Example: "100".

       • tax: string (numeric value as string)

         • The amount of tax applied to the service price. Example: "10".

       • total: string (numeric value as string)

         • The total price including tax. Example: "110"

   • Sample data:

   {  
   "id": "cc7e7245-3fed-4803-b5ac-8113db5bbfb1",  
   "name": "Sample Proposal",  
   "due_date": "2021-12-31",  
   "preview_url": "<https://example.com/pm/proposals/preview/123>",  
   "start_date": "2021-12-01",  
   "end_date": "2021-12-31",  
   "created_at": "2024-09-05T10:54:56.011778+05:30",  
   "staff": [  
   {  
   "name": "John Doe",  
   "email": "[email protected]"  
    }  
   ],  
   "signatory": [  
   {  
   "name": "Jane Doe",  
   "email": "[email protected]",  
   "url": "<https://example.com/shared/proposals/123>"  
    }  
   ],  
   "services": [  
   {  
   "name": "Sample Service",  
   "description": "Sample Description",  
   "pricing_method": "fixed",  
   "billing_type": "one_time",  
   "price": "100",  
   "tax": "10",  
   "total": "110"  
    }  
   ]  
   }
   

4. Proposal lost

   • Description: Triggers when a proposal is marked as lost.

   • Key: proposal_lost

   • Output description:

     • id: string

       • The unique identifier for the proposal. Example: "cbddb2fd-60b6-4c25-a69c-17fbde34a148".

     • lost_reason: string

       • The reason for losing this proposal. Example: "Price mismatch".

     • name: string

       • The name or title of the proposal. Example: "Sample Proposal".

     • due_date: string (ISO 8601 format)

       • The date by which the proposal should be reviewed or completed. Example: "2021-12-31".

     • preview_url: string

       • A URL where the preview of the proposal can be accessed. Example: "<https://example.com/pm/proposals/preview/123>".

     • start_date: string (ISO 8601 format)

       • The starting date for the proposal activities or services. Example: "2021-12-01".

     • end_date: string (ISO 8601 format)

       • The completion date for the proposal activities or services. Example: "2021-12-31".

     • created_at: string (ISO 8601 format with timezone)

       • The date and time when the proposal was created. Example: "2024-09-05T11:06:00.910465+05:30".

     • published_at: string (ISO 8601 format with timezone)

       • The date and time when the proposal was published. Example: "2024-09-05T11:06:00.910465+05:30".

     • sent_at: string (optional)

       • The date and time when the proposal was sent to stakeholders. Empty if not yet sent. Example: "".

     • staff: array of objects

       • A list of staff members associated with the proposal.

       • name: string

         • The name of a staff member. Example: "John Doe".

       • email: string

         • The email address of the staff member. Example: "[email protected]".

     • signatory: array of objects

       • A list of client contacts who must sign the proposal.

       • name: string

         • The name of the signatory. Example: "Jane Doe".

       • email: string

         • The email address of the signatory. Example: "[email protected]".

       • signed at: The date and time when this signatory signed the proposal. Example: "2024-09-05T11:06:00.910465+05:30"

     • services: array of objects

       • The list of services included in the proposal.

       • name: string

         • The name of the service. Example: "Sample Service".

       • description: string

         • A brief description of the service. Example: "Sample Description".

       • pricing_method: string

         • The method used to price the service. Possible values include "fixed", "hourly", etc. Example: "fixed".

       • billing_type: string

         • Indicates the type of billing, whether one-time or recurring. Example: "one_time".

       • price: string (numeric value as string)

         • The base price of the service before tax. Example: "100".

       • tax: string (numeric value as string)

         • The amount of tax applied to the service price. Example: "10".

       • total: string (numeric value as string)

         • The total price including tax. Example: "110"

   • Sample data:

   {  
   "id": "16e407c3-8aab-481b-8722-a5333da35c51",  
   "name": "Sample Proposal",  
   "due_date": "2021-12-31",  
   "preview_url": "<https://example.com/pm/proposals/preview/123>",  
   "start_date": "2021-12-01",  
   "end_date": "2021-12-31",  
   "created_at": "2024-09-05T11:10:55.185506+05:30",  
   "published_at": "2024-09-05T11:10:55.185506+05:30",  
   "sent_at": "",  
   "staff": [  
   {  
   "name": "John Doe",  
   "email": "[email protected]"  
    }  
   ],  
   "signatory": [  
   {  
   "name": "Jane Doe",  
   "email": "[email protected]"  
    }  
   ],  
   "services": [  
   {  
   "name": "Sample Service",  
   "description": "Sample Description",  
   "pricing_method": "fixed",  
   "billing_type": "one_time",  
   "price": "100",  
   "tax": "10",  
   "total": "110"  
    }  
   ],  
   "lost_reason": "Sample Reason"  
   }
   

5. Proposal revoked

   • Description: Triggers when a proposal is revoked.

   • Key: proposal_revoked

   • Output description:

     • id: string

       • The unique identifier for the proposal. Example: "cbddb2fd-60b6-4c25-a69c-17fbde34a148".

     • revoke reason: string

       • The reason for revoking this proposal. Example: "Price mismatch".

     • name: string

       • The name or title of the proposal. Example: "Sample Proposal".

     • due_date: string (ISO 8601 format)

       • The date by which the proposal should be reviewed or completed. Example: "2021-12-31".

     • preview_url: string

       • A URL where the preview of the proposal can be accesse

Article truncated. Full version available in source.