Versions Compared

Key

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

To learn more about webhooks, please visit our standard API documentation.  If you are unable to view, please reach out to support@sighten.io and they will provide access.

...

  • site (uuid) - this is the site UUID - this ID is 1:1 with a job in Sighten.  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 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.  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.  You can also pull this via the DAL or just use current day's date when you receive a signed webhook.
    • Please note, depending on the configuration of 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).

...