To learn more about subscribing to webhooks, please visit our standard API documentation Credential & Webhook articles. If you are unable to view, please reach out to support@goeverbright.com and they will provide access.
...
The milestone webhook is sent to the configured endpoint whenever a milestone is submitted for approval, rejected, or approved. Depending on your level of integration, you may only want to consume to “Submit for the “Milestone Approval” webhook as that can be used as a trigger to transfer information in real-time. You may also want to complete the full operational process via the API; they will result in utilizing other APIs to post approvals or rejections, and leave comments. With the automatic update from the webhook, you can pull down all the homeowner, usage, project, quote, report, or change order data 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.
...
site (uuid) - 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 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. Please note that if a re-sign task is completed within the milestone for a different quote, and then the webhook is sent, the quote UUID will still be the initial quote.sub_tasks > data > documents /old quote. The Change Order webhook can be used to mitigate this from becoming a problem.
sub_tasks > uuid - you will need to store this information and make a GET request to: /api/v1/documentsub_task/{uuid}/download/ to download the document. 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_all/ to download the Contract package.
status - this is the status of the milestone.
milestone_definition alias - this the uuid of that the milestone is created from. Use this a standardized name across product lines that can be used to understand the milestone the user took an action on.
M1 alias = projectqualification
M2 alias = installationcomplete
M3 alias = pto
There is A LOT more data in the milestone webhook. If you have any questions, please reach out to to your integration manager or support@goeverbright.com.
...