Tips and Tricks: The Change Order Webhook

The Change Order Webhook Statuses + DAL

The change order webhook is sent to the configured endpoint whenever there is a signed contract on a product and a change order is generated. Most commonly, integrated partners only consume the webhook when the status is SIGN, and then parse out the desired information. This ensures the homeowner has fully agreed to the change order 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 Change Order Webhook

Upon receiving the change order webhook, most integrated partners store down the following:

Status: the status of the task
Name: name of the task
New quote: uuid of the quote included in the change order
Site: this is the site UUID - this ID is 1:1 with a job in 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 exists in your portal.
Quote: 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.
date_updated: date updated - expect this is the same date/time as when a new event occurs
sub_tasks: an array of multiple subtasks
- category: subtask category
- required: true/false if subtask is required
- document_status: status of the change order envelope
- instructions: instructions saved on the task definition
- label: label saved on the task definition
- data: specific to the subtask

There is A LOT more data in the change order 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

{
  "milestone": "9f53239b-499f-47d4-884f-2bb228bef5aa",
  "milestone_definition": "124b03be-cc87-4ab6-98df-004621bc22af",
  "name": "Change Order 1",
  "date_updated": "2021-06-01T04:07:59.863095Z",
  "status": "INPROG",
  "description": "Complete change order if necessary",
  "comments": [
    {
      "uuid": "5f9276a4-5636-4d38-a4f4-82778d2c38ba",
      "comment": "Sighten Admin generated Contract.pdf for sub task Change Order 1.",
      "comment_type": "AUTO",
      "thread": null,
      "commenter_id": "cfece046-65fc-48c5-9811-08e8b941d8ef",
      "commentor": "sightenbot@sighten.io",
      "commentor_first_name": "Sighten",
      "commentor_last_name": "Bot",
      "last_updated": null,
      "timestamp": "2021-06-01T04:21:42.822885Z",
      "private": false
    },
    {
      "uuid": "f81d9e5d-ffc6-4bb5-bd49-1329c23c4b74",
      "comment": "Sighten Admin sent Contract.pdf for signature for sub task Change Order 1.",
      "comment_type": "AUTO",
      "thread": null,
      "commenter_id": "cfece046-65fc-48c5-9811-08e8b941d8ef",
      "commentor": "sightenbot@sighten.io",
      "commentor_first_name": "Sighten",
      "commentor_last_name": "Bot",
      "last_updated": null,
      "timestamp": "2021-06-01T04:23:44.549869Z",
      "private": false
    },
    {
      "uuid": "e8c62d7a-b361-4b17-956e-950a8d35804f",
      "comment": "Sighten Admin voided envelope out for signature for sub task Change Order 1.",
      "comment_type": "AUTO",
      "thread": null,
      "commenter_id": "cfece046-65fc-48c5-9811-08e8b941d8ef",
      "commentor": "sightenbot@sighten.io",
      "commentor_first_name": "Sighten",
      "commentor_last_name": "Bot",
      "last_updated": null,
      "timestamp": "2021-06-01T04:25:24.136184Z",
      "private": false
    },
    {
      "uuid": "958f1b91-e05f-4440-a365-37432c857d37",
      "comment": "Sighten Admin generated Contract.pdf for sub task Change Order 1.",
      "comment_type": "AUTO",
      "thread": null,
      "commenter_id": "cfece046-65fc-48c5-9811-08e8b941d8ef",
      "commentor": "sightenbot@sighten.io",
      "commentor_first_name": "Sighten",
      "commentor_last_name": "Bot",
      "last_updated": null,
      "timestamp": "2021-06-01T04:31:01.880395Z",
      "private": false
    },
    {
      "uuid": "e86a3197-0f6f-4112-b548-5d56906ec284",
      "comment": "Sighten Admin sent Contract.pdf for signature for sub task Change Order 1.",
      "comment_type": "AUTO",
      "thread": null,
      "commenter_id": "cfece046-65fc-48c5-9811-08e8b941d8ef",
      "commentor": "sightenbot@sighten.io",
      "commentor_first_name": "Sighten",
      "commentor_last_name": "Bot",
      "last_updated": null,
      "timestamp": "2021-06-01T04:31:21.404856Z",
      "private": false
    },
    {
      "uuid": "1a4ffa8f-5ac5-4051-9bb7-a6d78135bb22",
      "comment": "Change Order 1 - Signed.pdf was uploaded to sub task Change Order 1 from Docusign.",
      "comment_type": "AUTO",
      "thread": null,
      "commenter_id": "cfece046-65fc-48c5-9811-08e8b941d8ef",
      "commentor": "sightenbot@sighten.io",
      "commentor_first_name": "Sighten",
      "commentor_last_name": "Bot",
      "last_updated": null,
      "timestamp": "2021-06-01T04:35:42.343125Z",
      "private": false
    }
  ],
  "sub_tasks": [
    {
      "uuid": "efc6f47a-ba0d-4634-9584-6be80721227b",
      "label": "Change Order 1",
      "instructions": null,
      "category": "DOCUMENT",
      "required": false,
      "status": "COMP",
      "document_status": "SIGN",
      "data": {
        "documents": [
          {
            "uuid": "de66a0c5-f0e6-42cf-9a90-0e9b2a6f49f9",
            "name": "Contract.pdf",
            "document_type": "OTH",
            "document_group": "fb50e41e-9a47-44e1-bbbb-4bd31cca51f8",
            "creation_type": "GENERATED",
            "date_created": "2021-06-01T04:21:41.442723Z"
          },
          {
            "uuid": "bdeb94c3-b0b8-4495-a231-c5463a6f1ad6",
            "name": "Contract.pdf",
            "document_type": "OTH",
            "document_group": "fa1d258b-ac16-4363-9732-a70a6223e7b9",
            "creation_type": "GENERATED",
            "date_created": "2021-06-01T04:31:00.801467Z"
          },
          {
            "uuid": "af7f4ab9-1839-40a5-9f09-6196bec521fa",
            "name": "Change Order 1 - Signed.pdf",
            "document_type": "OTH",
            "document_group": "fa1d258b-ac16-4363-9732-a70a6223e7b9",
            "creation_type": "UPLOADED",
            "date_created": "2021-06-01T04:35:40.852011Z"
          }
        ],
        "envelopes": [
          {
            "uuid": "ea036cf3-831f-4bd4-a0ee-a9f1c37b2439",
            "name": "Swell ESA DTC Contract",
            "resource_id": "ac708c14-2ec1-46ba-b631-7f81e0af3264",
            "date_sent": "2021-06-01T04:23:44.521511Z",
            "date_signed": null,
            "date_voided": "2021-06-01T04:25:23.565399Z",
            "status": "VOID",
            "document_group": "fb50e41e-9a47-44e1-bbbb-4bd31cca51f8",
            "task_action_alias": "DSN"
          },
          {
            "uuid": "1a393c87-1a40-4ee0-9ff3-6d5e2268deeb",
            "name": "Swell ESA DTC Contract",
            "resource_id": "74ebea74-999c-45db-835e-a0c659204b29",
            "date_sent": "2021-06-01T04:31:21.380932Z",
            "date_signed": "2021-06-01T04:35:39.002284Z",
            "date_voided": null,
            "status": "COMP",
            "document_group": "fa1d258b-ac16-4363-9732-a70a6223e7b9",
            "task_action_alias": "DSN"
          }
        ]
      },
      "signers": [
        {
          "date_created": "2021-06-01T04:07:59.992168Z",
          "date_updated": "2021-06-01T04:33:33.830497Z",
          "created_by": "147f1938-5e59-4581-8f62-2c7c87a7cd76",
          "modified_by": "147f1938-5e59-4581-8f62-2c7c87a7cd76",
          "uuid": "6311e0e2-8385-44f4-99b1-322a3e13b7be",
          "legal_contact_signer": "8996638a-0027-4978-bb4a-3269c9fa84ba",
          "user_signer": null,
          "contact_signer": null,
          "signer_type": "H",
          "order": 1,
          "status": "COMP",
          "can_update": false,
          "date_sent": "2021-06-01T04:31:21.475359Z",
          "date_signed": "2021-06-01T04:33:33.830316Z",
          "date_declined": null,
          "date_voided": "2021-06-01T04:25:23.574570Z",
          "email": "test@sighten.io",
          "first_name": "QA",
          "last_name": "User"
        },
        {
          "date_created": "2021-06-01T04:08:00.072432Z",
          "date_updated": "2021-06-01T04:35:38.985578Z",
          "created_by": "147f1938-5e59-4581-8f62-2c7c87a7cd76",
          "modified_by": "147f1938-5e59-4581-8f62-2c7c87a7cd76",
          "uuid": "b2bb1609-dac0-41ec-96b8-4c071e90067c",
          "legal_contact_signer": null,
          "user_signer": "a5acfb2b-e0f2-4754-938c-8b67344e2d69",
          "contact_signer": null,
          "signer_type": "F",
          "order": 2,
          "status": "COMP",
          "can_update": false,
          "date_sent": "2021-06-01T04:33:33.856406Z",
          "date_signed": "2021-06-01T04:35:38.985448Z",
          "date_declined": null,
          "date_voided": "2021-06-01T04:25:23.574570Z",
          "email": "contracts@swellenergy.com",
          "first_name": "Shawn",
          "last_name": "Jacobson"
        }
      ]
    }
  ],
  "uuid": "2c53baa0-24c0-4bdd-94b4-09db4c524afb",
  "task_definition": "7a37d5da-ca46-4259-8ddc-9b10018019fc",
  "quote": "f402dbad-d8c1-4791-8ce1-b5b585027ffb",
  "new_quote": "f402dbad-d8c1-4791-8ce1-b5b585027ffb",
  "site": "dc6ca696-819e-44a2-9371-2650a0b37251",
  "assigned_to": null
}