Versions Compared

Old Version 8

changes.mady.by.user Tim Marchese

Saved on

compared with

New Version Current

changes.mady.by.user John Kilfoil

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

The Contract Webhook Statuses + DAL

The contract webhook is sent to the configured endpoint whenever a document is generated, sent, signed, and voided.  Most commonly, integrated partners only consume the webhook when the status is SIGN, and then parse out the desired information.  This ensure the homeowner has fully agreed to the proposal and is ready to move forward.  With the automatic update from the webhook, you can now pull down all the homeowner, usage, project, and quote details that you need without any additional user interaction: simply fire off another request to pull down the data.  You can learn more about the DAL here.

Fields in the Contract Webhook

Upon receiving

...

the contract webhook, most integrated partners store down the following:

  • site (uuid) - this is the site UUID - this ID is 1:1 with a job in

    Sighten

    EverBright.  You may want to use this to create a new record in your portal and maintain the job sync, or use the identifier to find a job that already existing in your portal.

  • quote (uuid) - this is the quote UUID is similar to the site ID, except that it is not 1:1; there can be any number of quotes on a given job (or site).  The quote ID is also important here because it signifies and helps access all the contracted details.

  • sub_tasks > document_status - this will be SIGN when

    the contract is

    the contract is full executed

  • sub_tasks > data > documents > uuid - you will need to store this information and make a GET request to: /api/v1/document/{uuid}/download/ to download the

    signed contract

    signed contract.  You will take the document uuid where the "creation_type" is "UPLOADED".

    • You can also access a direct link for the document via: /api/v1/document/{uuid}/preview/

  • sub_tasks > data > envelopes > date_signed - this will populate with date of the

    signed contract

    signed contract.  You can also pull this via the DAL or just use current day's date when you receive a

    signed webhook

    signed webhook.

    • Please note, depending on the configuration of

      your contract tasks

      your contract tasks, there may be multiple subtasks.  To ensure you are pulling from the right subtask, you will want to identify the sub_task with category: DOCUMENT (there can only be one DOCUMENT subtask per task, so if you do the right logic, you will have the right subtask).

There is A LOT more data in the contract webhook.  If you have any questions, please reach out to 

...

support@goeverbright.

...

com.  

Document Status:

GEN = generated

SENT = sent

SIGN = signed

VOID = voided

Sample Contract Webhook


Code Block
{
     'status':'INPROG',
   'name':'Installation Agreement',
   'quote':'7cf8d5db-bb05-4a39-a40b-c83e17988c37',
   'milestone':'8c884d2d-a84c-4376-be9c-d4f380828478',
   'site':'b0c16879-5c5f-4dd9-8442-65cc594372ed',
   'uuid':'060d5cb4-374a-4c31-8f41-9e530c71ffff',
   'date_updated':'2019-11-26T20:24:59.613449Z',
   'sub_tasks':[ 
      { 
         'category':'DOCUMENT',
         'required':False,
         'status':'COMP',
         'document_status':'SIGN',
         'instructions':None,
         'label':'Installation Agreement',
         'data':{ 
            'documents':[ 
               { 
                  'date_created':'2019-11-26T20:25:27.275049Z',
                  'name':'Cash Installation Agreement.pdf',
                  'document_type':'HIC',
                  'creation_type':'GENERATED',
                  'document_group':'d397b480-6b52-4ee0-9ff9-9725fd91dbed',
                  'uuid':'451c2577-96b7-48dd-a7d0-eb2e47293e96'
               },
               { 
                  'date_created':'2019-11-26T20:25:43.659696Z',
                  'name':'Cash Installation Agreement (2).pdf',
                  'document_type':'OTH',
                  'creation_type':'UPLOADED',
                  'document_group':'d397b480-6b52-4ee0-9ff9-9725fd91dbed',
                  'uuid':'e24f5a7a-1d6d-4417-8af2-22da3d67d4cc'
               }
            ],
            'envelopes':[ 

            ]
         },
         'uuid':'161e657f-758d-4b54-83d3-7a019c41c5fa'
      }
   ],
   'comments':[ 
      { 
         'comment':'Sighten Admin generated Cash Installation Agreement.pdf for sub task Installation Agreement.',
         'commentor':'sightenbot@sighten.io',
         'thread':None,
         'timestamp':'2019-11-26T20:25:27.328990Z',
         'uuid':'5f3af19f-b637-467a-bba2-67acb2d55eaf',
         'commentor_first_name':'Sighten',
         'commentor_last_name':'Bot'
      },
      { 
         'comment':'Sighten Admin uploaded a document Cash Installation Agreement (2).pdf to sub task Installation Agreement.',
         'commentor':'sightenbot@sighten.io',
         'thread':None,
         'timestamp':'2019-11-26T20:25:45.366284Z',
         'uuid':'8ef11d2c-60a0-4b9c-8854-d46f13ad5037',
         'commentor_first_name':'Sighten',
         'commentor_last_name':'Bot'
      }
   ],
   'description':'Upload and review installation agreement',
   'assigned_to':{ 
      'organization_name':'Solar Energy',
      'first_name':'Generic',
      'uuid':'12b70751-195d-4315-b8a6-a6c6076b3669',
      'last_name':'Operations',
      'email':'contracts@solar.com',
      'organization':'b7534251-dd34-4ab2-994d-3cdd6d83ec8f'
   }  "uuid":"fb04303e-da8f-413a-b9fc-b91dedf10707",
    "quote":"042e6753-6b06-457d-9efd-70f047f4d348",
    "sub_tasks":[
      {
        "uuid":"42cae220-d016-4a2f-87d7-7a41fd9eaebc",
        "document_status":"SIGN",
        "data":{
          "attachments":[],
          "envelopes":[
            {
              "uuid":"3c7b94a1-c4e8-42b5-9800-ddbac9dea9a1",
              "date_sent":"2023-07-12T19:16:41.344402Z",
              "date_signed":"2023-07-12T19:22:17.752365Z",
              "date_voided":null,
              "resource_id":"4484f261-aabd-489b-ba1f-9bb5b7b25cd9",
              "document_group":"fb4753df-1f0b-4f3a-b916-d7a07af89781",
              "task_action_alias":"DSN",
              "status":"COMP",
              "name":"EverBright EverOwn Contract"
            }
          ],
          "documents":[
            {
              "document_type":"OTH",
              "uuid":"ea27e915-2d04-4e4b-85b2-d89c6500d495",
              "stale":false,
              "creation_type":"GENERATED",
              "date_created":"2023-06-19T20:14:15.388291Z",
              "name":"Contract.pdf",
              "upload_batch":null,
              "document_group":"fb4753df-1f0b-4f3a-b916-d7a07af89781"
            },
            {
              "document_type":"OTH",
              "uuid":"3f230ca4-b147-49ae-9187-8b64c7eea62c",
              "stale":false,
              "creation_type":"UPLOADED",
              "date_created":"2023-07-12T19:22:28.347932Z",
              "name":"California Solar Consumer Protection Guide - Signed.pdf",
              "upload_batch":1,
              "document_group":"fb4753df-1f0b-4f3a-b916-d7a07af89781"
            },
            {
              "document_type":"OTH",
              "uuid":"40e6a92d-9cc9-4a9d-8cae-36e85736e7b1",
              "stale":false,
              "creation_type":"UPLOADED",
              "date_created":"2023-07-12T19:22:30.724849Z",
              "name":"California Solar Consumer Protection Guide (Last Page) - Signed.pdf",
              "upload_batch":1,
              "document_group":"fb4753df-1f0b-4f3a-b916-d7a07af89781"
            },
            {
              "document_type":"OTH",
              "uuid":"6588bff2-16ad-43a0-86b1-4985f5100fdd",
              "stale":false,
              "creation_type":"UPLOADED",
              "date_created":"2023-07-12T19:22:32.263496Z",
              "name":"Installation Agreement - Signed.pdf",
              "upload_batch":1,
              "document_group":"fb4753df-1f0b-4f3a-b916-d7a07af89781"
            },
            {
              "document_type":"OTH",
              "uuid":"0ab44b6d-22c0-444e-bd47-97ddd54bcd3f",
              "stale":false,
              "creation_type":"UPLOADED",
              "date_created":"2023-07-12T19:22:33.801037Z",
              "name":"SDGE - NEM - Signed.pdf",
              "upload_batch":1,
              "document_group":"fb4753df-1f0b-4f3a-b916-d7a07af89781"
            },
            {
              "document_type":"OTH",
              "uuid":"de652965-e65b-4b77-a41f-50131ff7d0f0",
              "stale":false,
              "creation_type":"UPLOADED",
              "date_created":"2023-07-12T19:22:35.916822Z",
              "name":"California Solar Disclosure (EverOwn) - Signed.pdf",
              "upload_batch":1,
              "document_group":"fb4753df-1f0b-4f3a-b916-d7a07af89781"
            },
            {
              "document_type":"OTH",
              "uuid":"cef75a3b-1bc1-44bd-a5b1-fe09ee545a15",
              "stale":false,
              "creation_type":"UPLOADED",
              "date_created":"2023-07-12T19:22:37.602116Z",
              "name":"California - EverBright RIC 2.0 Agreement - Signed.pdf",
              "upload_batch":1,
              "document_group":"fb4753df-1f0b-4f3a-b916-d7a07af89781"
            },
            {
              "document_type":"OTH",
              "uuid":"b9110b4c-a109-441c-8bb4-1688570ead70",
              "stale":false,
              "creation_type":"UPLOADED",
              "date_created":"2023-07-12T19:22:39.409490Z",
              "name":"Welcome Call Checklist Single Signer 2.0 (EverOwn and EverOwn Plus) - Signed.pdf",
              "upload_batch":1,
              "document_group":"fb4753df-1f0b-4f3a-b916-d7a07af89781"
            },
            {
              "document_type":"OTH",
              "uuid":"4e6590da-74ce-4d60-9cd9-e984cbfeeb1f",
              "stale":false,
              "creation_type":"UPLOADED",
              "date_created":"2023-07-12T19:22:42.121663Z",
              "name":"EverOwn Assignment Form hidden - Signed.pdf",
              "upload_batch":1,
              "document_group":"fb4753df-1f0b-4f3a-b916-d7a07af89781"
            },
            {
              "document_type":"OTH",
              "uuid":"4fa4f358-9bc4-4ef8-911b-a72c46ee14bc",
              "stale":false,
              "creation_type":"UPLOADED",
              "date_created":"2023-07-12T19:22:45.225422Z",
              "name":"certificate - Signed.pdf",
              "upload_batch":1,
              "document_group":"fb4753df-1f0b-4f3a-b916-d7a07af89781"
            }
          ]
        },
        "required":true,
        "instructions":"a. A person on title must be on the agreement.\nb. A person with approved credit must be on the agreement.\nc. Amount financed must be less than property value.\nd. If signer email or phone number needs to be updated, the legal contact information may be accessed and updated in the Qualification Phase.\ne. If signer names need to be updated, please contact us at dealprocessing@goeverbright.com or call 833-830-0475.\nf. DocuSign signature must match legal contact names.",
        "status":"COMP",
        "signers":[
          {
            "date_declined":null,
            "uuid":"87f739ce-ef0e-4d34-927e-a0f6c321dc49",
            "date_sent":"2023-06-19T20:14:38.020668Z",
            "can_update":true,
            "date_voided":null,
            "legal_contact_signer":null,
            "modified_by":"1fe0e5ce-60c4-4fda-975b-a46d56b27f95",
            "last_name":"Bright",
            "status":"COMP",
            "contact_signer":null,
            "first_name":"Ever",
            "email":"john.kilfoil@goeverbright.com",
            "order":1,
            "created_by":"1fe0e5ce-60c4-4fda-975b-a46d56b27f95",
            "date_signed":"2023-06-22T02:00:28.466384Z",
            "signer_type":"S",
            "user_signer":"b9c2a75e-2a6c-47b5-9fd0-74fad889853f",
            "date_updated":"2023-06-22T02:00:28.466607Z",
            "date_created":"2023-06-19T20:11:47.240547Z"
          },
          {
            "date_declined":null,
            "uuid":"50fe34fb-3696-4570-8197-e65bf48e3a95",
            "date_sent":"2023-07-07T02:34:24.202029Z",
            "can_update":false,
            "date_voided":null,
            "legal_contact_signer":"0d65eb77-4236-4d44-ae4d-248565c12047",
            "modified_by":"1fe0e5ce-60c4-4fda-975b-a46d56b27f95",
            "last_name":"Owner",
            "status":"COMP",
            "contact_signer":null,
            "first_name":"Home",
            "email":"john.kilfoil2@goeverbright.com",
            "order":2,
            "created_by":"1fe0e5ce-60c4-4fda-975b-a46d56b27f95",
            "date_signed":"2023-07-08T08:16:40.951685Z",
            "signer_type":"H",
            "user_signer":null,
            "date_updated":"2023-07-08T08:16:40.951808Z",
            "date_created":"2023-06-19T20:11:47.301636Z"
          },
          {
            "date_declined":null,
            "uuid":"1664559b-fcd6-471c-a609-e34abdbc71bf",
            "date_sent":"2023-07-12T19:16:41.509554Z",
            "can_update":true,
            "date_voided":null,
            "legal_contact_signer":null,
            "modified_by":"1fe0e5ce-60c4-4fda-975b-a46d56b27f95",
            "last_name":"xxxxxxx",
            "status":"COMP",
            "contact_signer":null,
            "first_name":"xxxxx",
            "email":"john.kilfoil3@goeverbright.com",
            "order":3,
            "created_by":"1fe0e5ce-60c4-4fda-975b-a46d56b27f95",
            "date_signed":"2023-07-12T19:22:16.408523Z",
            "signer_type":"C",
            "user_signer":"b9c2a75e-2a6c-47b5-9fd0-74fad889853f",
            "date_updated":"2023-07-12T19:22:16.408800Z",
            "date_created":"2023-06-19T20:11:47.333919Z"
          }
        ],
        "label":"EverOwn Agreement",
        "category":"DOCUMENT"
      }
    ],
    "description":"",
    "assigned_to":{
      "uuid":"1fe0e5ce-60c4-4fda-975b-a46d56b27f95",
      "first_name":"xxxxx",
      "email":"john.kilfoil4@goeverbright.com",
      "organization_name":"YourSolarOrg",
      "organization":"825bca13-d78e-483a-96b3-6a18fb5779b4",
      "last_name":"xxxx"
    },
    "workflow":"711dc40f-59f7-440e-87a0-0c35f03a20b3",
    "status":"READY",
    "name":"EverOwn Agreement",
    "milestone_definition":"88ddfce5-97c1-4f43-9675-070a1c0faf84",
    "task_definition":"e30fdc45-322c-4b42-abff-8bc4deb71396",
    "comments":[
      {
        "private":false,
        "uuid":"7f8ad482-0d48-4014-8d26-79de2fb8751b",
        "commentor_first_name":"EverBright",
        "timestamp":"2023-07-12T19:22:47.921491Z",
        "comment_type":"AUTO",
        "commentor_last_name":"Bot",
        "comment":"certificate - Signed.pdf was uploaded to sub task EverOwn Agreement from Docusign.",
        "last_updated":null,
        "thread":null,
        "commenter_id":"cfece046-65fc-48c5-9811-08e8b941d8ef",
        "commentor":"everbrightbot@goeverbright.com"
      },
      {
        "private":false,
        "uuid":"1fb0ef4f-11b5-49d1-b43a-9521f1112d61",
        "commentor_first_name":"EverBright",
        "timestamp":"2023-07-12T19:22:45.218107Z",
        "comment_type":"AUTO",
        "commentor_last_name":"Bot",
        "comment":"EverOwn Assignment Form hidden - Signed.pdf was uploaded to sub task EverOwn Agreement from Docusign.",
        "last_updated":null,
        "thread":null,
        "commenter_id":"cfece046-65fc-48c5-9811-08e8b941d8ef",
        "commentor":"everbrightbot@goeverbright.com"
      },
      {
        "private":false,
        "uuid":"bee55cd5-8147-4138-a6e2-e6e7c28b3078",
        "commentor_first_name":"EverBright",
        "timestamp":"2023-07-12T19:22:42.117284Z",
        "comment_type":"AUTO",
        "commentor_last_name":"Bot",
        "comment":"Welcome Call Checklist Single Signer 2.0 (EverOwn and EverOwn Plus) - Signed.pdf was uploaded to sub task EverOwn Agreement from Docusign.",
        "last_updated":null,
        "thread":null,
        "commenter_id":"cfece046-65fc-48c5-9811-08e8b941d8ef",
        "commentor":"everbrightbot@goeverbright.com"
      },
      {
        "private":false,
        "uuid":"1f7d2a4b-2ef3-4819-a68a-0362cd70eb50",
        "commentor_first_name":"EverBright",
        "timestamp":"2023-07-12T19:22:39.406929Z",
        "comment_type":"AUTO",
        "commentor_last_name":"Bot",
        "comment":"California - EverBright RIC 2.0 Agreement - Signed.pdf was uploaded to sub task EverOwn Agreement from Docusign.",
        "last_updated":null,
        "thread":null,
        "commenter_id":"cfece046-65fc-48c5-9811-08e8b941d8ef",
        "commentor":"everbrightbot@goeverbright.com"
      },
      {
        "private":false,
        "uuid":"d95c16e2-b377-48e8-9115-d923b215e9e4",
        "commentor_first_name":"EverBright",
        "timestamp":"2023-07-12T19:22:37.600114Z",
        "comment_type":"AUTO",
        "commentor_last_name":"Bot",
        "comment":"California Solar Disclosure (EverOwn) - Signed.pdf was uploaded to sub task EverOwn Agreement from Docusign.",
        "last_updated":null,
        "thread":null,
        "commenter_id":"cfece046-65fc-48c5-9811-08e8b941d8ef",
        "commentor":"everbrightbot@goeverbright.com"
      },
      {
        "private":false,
        "uuid":"21112bc4-50c7-4590-8f4a-bb4bdad5b83c",
        "commentor_first_name":"EverBright",
        "timestamp":"2023-07-12T19:22:35.913717Z",
        "comment_type":"AUTO",
        "commentor_last_name":"Bot",
        "comment":"SDGE - NEM - Signed.pdf was uploaded to sub task EverOwn Agreement from Docusign.",
        "last_updated":null,
        "thread":null,
        "commenter_id":"cfece046-65fc-48c5-9811-08e8b941d8ef",
        "commentor":"everbrightbot@goeverbright.com"
      },
      {
        "private":false,
        "uuid":"f8eca6a1-ae0b-4180-bb38-01d72d26ab5a",
        "commentor_first_name":"EverBright",
        "timestamp":"2023-07-12T19:22:33.790620Z",
        "comment_type":"AUTO",
        "commentor_last_name":"Bot",
        "comment":"Installation Agreement - Signed.pdf was uploaded to sub task EverOwn Agreement from Docusign.",
        "last_updated":null,
        "thread":null,
        "commenter_id":"cfece046-65fc-48c5-9811-08e8b941d8ef",
        "commentor":"everbrightbot@goeverbright.com"
      },
      {
        "private":false,
        "uuid":"50ea5dab-122a-4bd7-81be-50164982a36b",
        "commentor_first_name":"EverBright",
        "timestamp":"2023-07-12T19:22:32.261053Z",
        "comment_type":"AUTO",
        "commentor_last_name":"Bot",
        "comment":"California Solar Consumer Protection Guide (Last Page) - Signed.pdf was uploaded to sub task EverOwn Agreement from Docusign.",
        "last_updated":null,
        "thread":null,
        "commenter_id":"cfece046-65fc-48c5-9811-08e8b941d8ef",
        "commentor":"everbrightbot@goeverbright.com"
      },
      {
        "private":false,
        "uuid":"397e5d44-a758-4697-9c63-fdee82c4c209",
        "commentor_first_name":"EverBright",
        "timestamp":"2023-07-12T19:22:30.721658Z",
        "comment_type":"AUTO",
        "commentor_last_name":"Bot",
        "comment":"California Solar Consumer Protection Guide - Signed.pdf was uploaded to sub task EverOwn Agreement from Docusign.",
        "last_updated":null,
        "thread":null,
        "commenter_id":"cfece046-65fc-48c5-9811-08e8b941d8ef",
        "commentor":"everbrightbot@goeverbright.com"
      },
      {
        "private":false,
        "uuid":"e818f6f9-3efd-46d8-ab51-7672838fff62",
        "commentor_first_name":"EverBright",
        "timestamp":"2023-07-12T19:16:41.453386Z",
        "comment_type":"AUTO",
        "commentor_last_name":"Bot",
        "comment":"John Kilfoil re-sent Contract.pdf for signature for sub task EverOwn Agreement.",
        "last_updated":null,
        "thread":null,
        "commenter_id":"cfece046-65fc-48c5-9811-08e8b941d8ef",
        "commentor":"everbrightbot@goeverbright.com"
      },
      {
        "private":false,
        "uuid":"27ada40b-0009-4c8f-a944-7e4414731617",
        "commentor_first_name":"EverBright",
        "timestamp":"2023-07-07T02:34:24.186231Z",
        "comment_type":"AUTO",
        "commentor_last_name":"Bot",
        "comment":"John Kilfoil re-sent Contract.pdf for signature for sub task EverOwn Agreement.",
        "last_updated":null,
        "thread":null,
        "commenter_id":"cfece046-65fc-48c5-9811-08e8b941d8ef",
        "commentor":"everbrightbot@goeverbright.com"
      },
      {
        "private":false,
        "uuid":"48bdc6d7-eed4-443a-bf2d-8b2a83c12a69",
        "commentor_first_name":"EverBright",
        "timestamp":"2023-06-23T04:02:25.919113Z",
        "comment_type":"AUTO",
        "commentor_last_name":"Bot",
        "comment":"John Kilfoil re-sent Contract.pdf for signature for sub task EverOwn Agreement.",
        "last_updated":null,
        "thread":null,
        "commenter_id":"cfece046-65fc-48c5-9811-08e8b941d8ef",
        "commentor":"everbrightbot@goeverbright.com"
      },
      {
        "private":false,
        "uuid":"80f26c8c-8ffa-46ea-a531-0f94b6ea38d6",
        "commentor_first_name":"EverBright",
        "timestamp":"2023-06-19T20:14:37.816227Z",
        "comment_type":"AUTO",
        "commentor_last_name":"Bot",
        "comment":"John Kilfoil sent Contract.pdf for signature for sub task EverOwn Agreement.",
        "last_updated":null,
        "thread":null,
        "commenter_id":"cfece046-65fc-48c5-9811-08e8b941d8ef",
        "commentor":"everbrightbot@goeverbright.com"
      },
      {
        "private":false,
        "uuid":"0c12be8e-32bc-4a3f-a637-ad344ea09872",
        "commentor_first_name":"EverBright",
        "timestamp":"2023-06-19T20:14:18.081461Z",
        "comment_type":"AUTO",
        "commentor_last_name":"Bot",
        "comment":"John Kilfoil generated Contract.pdf for sub task EverOwn Agreement.",
        "last_updated":null,
        "thread":null,
        "commenter_id":"cfece046-65fc-48c5-9811-08e8b941d8ef",
        "commentor":"everbrightbot@goeverbright.com"
      }
    ],
    "site":"34b6b5ee-f997-4044-86ae-0abbf611fc4d",
    "date_updated":"2023-06-19T20:11:47.348506Z",
    "milestone":"a8c7b62c-12b4-4702-8a33-ee3bea17a326"
  }