Versions Compared

Old Version 4

changes.mady.by.user Tim Marchese

Saved on

compared with

New Version 5

changes.mady.by.user Tucker Marchese (Unlicensed)

Saved on

Key

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

Note: this feature is only available to customers with API integration. To learn more, please reach out to support@sightensupport@goeverbright.io.com

Webhooks (also called a web callback or HTTP push API) are a way for Sighten EverBright to provide other applications with real-time event-based information.

...

  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 Sighten EverBright logs.

  2. Select an Event to base the webhook off of.

    The available events are:

    1. Contract Recipient Status Change

    2. Contract Status Change

    3. Milestone Comment Created

    4. Milestone Status Change

    5. Task Comment Created

    6. Qualification Update

    7. Site Archived

  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 - dropdown: Each webhook is tied to a specific 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 - dropdown: you can select PUT, POST, or PATCH.

    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.

...