Versions Compared

Key

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

...

  1. Name your webhook: this should be something simple that identifies the webhook and is associated with your account to assist with any triaging of EverBright logs.

  2. Select an Event that will act as a trigger for the webhook

    Image Removedimage-20240514-183018.pngImage Added

    The available events are:

    1. Contract Recipient Status Change

    2. Contract Status Change

    3. Change Order Status Change

    4. Homeowners Signed Contract

    5. Milestone Comment Created

    6. Milestone Status Change

    7. Task Comment Created

    8. Qualification Update

    9. Site Archived

    10. Stage Transition

    11. Proposal Action

    12. Invoice Status Change

    13. Workflow Status Change

  3. Determine some settings for your Webhook:

    1. URL Path - this is the address for the API call when the event is triggered.

    2. Credential - this field is a dropdown menu. Each webhook is tied to a credential. If it is a test webhook, then you will only see test credentials and if it is a production credential, you will only see production credentials.

    3. HTTP Method - this field is a dropdown menu: you can select PUT, POST, or PATCH. Most partners select POST

    4. Test Webhook - toggle: This determines if the webhook is applied in a test (Onboard) or production environment (Engine). Once your webhook is created, there will be a test label next to the name for test webhooks.

    5. Active - toggle: This determines if the webhook is active or not. Once your webhook is created, there will be an inactive label next to the name for webhooks that have been deactivated.

...