Versions Compared

Key

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

...

From there, an Add Webhook modal will open.

...

  1. Name your webhook: this should be something simple that identifies the webhook.

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

    Image Added

    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

      Image Removed

  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:

    4. PUT: is most-often utilized for update capabilities

    5. POST: utilized to create new resources.

    6. PATCH: utilized when we only send the data that we need to modify without modifying or altering other parts of the data

      you can select PUT, POST, or PATCH.

    7. 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.

    8. 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.

...