Skip to content

Commit

Permalink
minor: Removed example URL since it no longer exists and fails "link …
Browse files Browse the repository at this point in the history
…check" workflow.
  • Loading branch information
vitaliyf committed Oct 9, 2024
1 parent e0b22ca commit f785354
Showing 1 changed file with 19 additions and 20 deletions.
39 changes: 19 additions & 20 deletions docs/best-practices/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,57 +3,56 @@ title: Webhooks
description: Webhook Integration Instructions
sidebar_position: 3
---
The Embrace Webhooks feature is an outgoing webhook sent by Embrace when an alert condition is met. Here is a high-level flow diagram:

The Embrace Webhooks feature is an outgoing webhook sent by Embrace when an alert condition is met. Here is a high-level flow diagram:

<img src={require('@site/static/images/webhooks/image1.png').default} />

## Generic Webhook

In order to see a sample of the payload sent by the Embrace dash, you can setup a test webhook with [webhook.site](https://webhook.site/):

First, within the Embrace dashboard, click on the gear icon to access the Settings page.
First, within the Embrace dashboard, click on the gear icon to access the Settings page.

<img src={require('@site/static/images/webhooks/image2.png').default} />

Select the Notifications tab.

In the Webhook Integration area, there is a Nickname field and the Webhook URL field:
In the Webhook Integration area, there is a Nickname field and the Webhook URL field:

<img src={require('@site/static/images/webhooks/image3.png').default} />

When you navigate to the [webhook.site](https://webhook.site/) page, you will get a randomly generated path; paste that path in the Webhook URL field in the Embrace dash.

For example: https://webhook.site/b8a8c93a-0111-48d0-aedc-051092311a6a
When you navigate to the [webhook.site](https://webhook.site/) page, you will get a randomly webhook URL; paste that path in the Webhook URL field in the Embrace dashboard.

<img src={require('@site/static/images/webhooks/image4.png').default} />

In this example, the Nickname is “webhook.site” and the Webhook URL is the random path from the webhook.site page.
In this example, the Nickname is “webhook.site” and the Webhook URL is the random path from the webhook.site page.

Click on TEST to see the webhook show up on webhook.site.
Click on TEST to see the webhook show up on webhook.site.

## Jira Integration

In your Project, click on Project settings
In your Project, click on Project settings

<img src={require('@site/static/images/webhooks/image5.png').default} />
<img src={require('@site/static/images/webhooks/image6.png').default} />

Then click on Create rule
Search for webhook, then click on Incoming webhook
Then click on Create rule
Search for webhook, then click on Incoming webhook

<img src={require('@site/static/images/webhooks/image7.png').default} />

Choose “No issues from the webhook”
Choose “No issues from the webhook”

Click Save
Click Save

Add a New action
Add a New action

Choose Create issue

<img src={require('@site/static/images/webhooks/image9.png').default} />

Complete the rest of the Jira automation per your organization’s needs.
Complete the rest of the Jira automation per your organization’s needs.

## PagerDuty Integration

Expand Down Expand Up @@ -90,18 +89,18 @@ Finally, copy the Integration URL generated in the CET Integration Configuration

## Troubleshooting Webhooks

Your webhook will be disabled if the alerts fail to deliver 3 times in a row.
Your webhook will be disabled if the alerts fail to deliver 3 times in a row.

<img src={require('@site/static/images/webhooks/image10.png').default} />

To fix the disabled webhook, select the webhook to edit. Re-test the webhook to validate.
To fix the disabled webhook, select the webhook to edit. Re-test the webhook to validate.

To examine the payload that is being sent, use the Webhook.site page mentioned above.
To examine the payload that is being sent, use the [webhook.site](https://webhook.site/) page mentioned above.

Invalid Webhooks will also trigger an email alert. For example, you will get an email alert similar to this:
Invalid Webhooks will also trigger an email alert. For example, you will get an email alert similar to this:

<img src={require('@site/static/images/webhooks/image11.png').default} />

After 2 failed email notifications, you will get a final email alert:
After 2 failed email notifications, you will get a final email alert:

<img src={require('@site/static/images/webhooks/image12.png').default} />

0 comments on commit f785354

Please sign in to comment.