Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SUMO-227597: documentation for 12 webhook doc only apps #2959

Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions cid-redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -2356,6 +2356,18 @@
"/cid/900": "/docs/beta",
"/cid/9000": "/docs/integrations/app-development/jmx",
"/cid/12323": "/docs/integrations/webhooks/buddy",
"/cid/12324": "/docs/integrations/webhooks/postman",
"/cid/12325": "/docs/integrations/webhooks/pusher",
"/cid/12326": "/docs/integrations/webhooks/rollbar",
"/cid/12327": "/docs/integrations/webhooks/sendgrid",
"/cid/12328": "/docs/integrations/webhooks/sentry",
"/cid/12329": "/docs/integrations/webhooks/split",
"/cid/12330": "/docs/integrations/webhooks/squadcast",
"/cid/12331": "/docs/integrations/webhooks/stripe",
"/cid/12332": "/docs/integrations/webhooks/superwise",
"/cid/12333": "/docs/integrations/webhooks/uptime",
"/cid/12334": "/docs/integrations/webhooks/zebrium-rcaas",
"/cid/12335": "/docs/integrations/webhooks/zenduty",
"/cid/9001": "/",
"/cid/09001": "/",
"/cid/09002": "/docs/manage/data-forwarding/manage",
Expand Down
51 changes: 51 additions & 0 deletions docs/integrations/webhooks/postman.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
id: postman
title: Postman
description: Learn about the collection process for the Postman integration.
---
import useBaseUrl from '@docusaurus/useBaseUrl';

<img src={useBaseUrl('img/integrations/webhooks/postman-logo.png')} alt="Thumbnail icon" width="50"/>

Postman is an API development tool that streamlines API building, testing, and modification. It simplifies the process of working with APIs for developers. A webhook available in the Postman can forward events related to changes occurred in your Postman platform to the Sumo Logic HTTP endpoint. Using these logs, you can monitor API test results, collection changes, monitor alerts, environment modifications, and custom automation workflow triggers in Sumo logic. For more details, refer to the [Postman Documentation](https://learning.postman.com/docs/introduction/overview/).
kimsauce marked this conversation as resolved.
Show resolved Hide resolved

## Event types

The Sumo Logic integration for Postman ingests Postman events into Sumo Logic through an outgoing webhook available in Postman. For more information on supported events that are ingested through the Postman webhook, see the [Postman documentation](https://learning.postman.com/docs/integrations/webhooks/).

## Setup

This section has instructions for collecting logs for the Sumo Logic Postman webhook collection.

### Source configuration
Follow the below steps to configure the Hosted Collector to receive Postman events.

1. In the Sumo Logic portal, create a new [Hosted Collector](https://help.sumologic.com/docs/send-data/hosted-collectors/configure-hosted-collector/) or use an existing one. Then add an [HTTP Logs and Metrics Source](https://help.sumologic.com/docs/send-data/hosted-collectors/http-source/logs-metrics/#configure-an-httplogs-and-metrics-source).
2. Configure **Source Category** in the HTTP Source. For example, configure as `webhook/postman` for the Postman integration.
3. Copy and save the endpoint URL of the source.
### Vendor configuration
Configure the webhook integration in Postman to send events to the Sumo Logic HTTP source. Once configured, it will be triggered each time the events occur within your Postman account.

Follow the below steps to configure the Postman webhook:

1. Sign in to your [Postman account](https://www.postman.com/).
2. On the home page, click on the **Integrations** tab from the left sidebar.
3. Search and select **Webhooks** from the list of integrations.
4. The integration page has choices for each type of custom webhook. Select **Add Integration** next to a webhook type to configure your integration. The webhook form will appear.
5. Enter webhook form data as follows:
- **Nickname**. Enter a Nickname for the integration.
- **Webhook URL**. Enter the Sumo Logic HTTP endpoint URL(source address) created above.
- For **Backup a collection** as the webhook type,
- **Choose workspace**. Select the workspace to which your collection belongs.
- **Choose Collection**. Select the collection you wish to send updates for.
- For **Post monitoring results** as the webhook type,
- **Choose workspace**. Select the workspace to which your collection belongs.
- **Choose Monitor**. Select the monitor you wish to send results for.
6. Click **Add Integration**.
7. Verify Postman events are getting ingested in Sumo Logic by executing the following query on Sumo Logic's search panel.
kimsauce marked this conversation as resolved.
Show resolved Hide resolved
`_sourcecategory=webhook/postman`

:::info
- For detailed information about webhook creation, refer [Postman Documentation](https://learning.postman.com/docs/integrations/webhooks/).
- For support, contact [Postman](https://support.postman.com/hc/en-us).
:::
51 changes: 51 additions & 0 deletions docs/integrations/webhooks/pusher.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
id: pusher
title: Pusher
description: Learn about the collection process for the Pusher integration.
---
import useBaseUrl from '@docusaurus/useBaseUrl';

<img src={useBaseUrl('img/integrations/webhooks/pusher-logo.png')} alt="Thumbnail icon" width="50"/>

Pusher is a real-time messaging and communication platform that simplifies adding live features to web and mobile applications, enabling instant updates, notifications, and interactive functionalities through WebSocket connections. A webhook available in the Pusher can forward events from Pusher platform to the Sumo Logic HTTP endpoint. Using these logs, you can monitor channel existence, presence status, client events, deferred actions, cache channels, and subscription counts in Sumo Logic. For more details, refer to the [Pusher Documentation](https://pusher.com/docs/).

## Event types

The Sumo Logic integration for Pusher ingests events into Sumo Logic through an outgoing webhook available in Pusher. The following event types are ingested through the Pusher webhook:
- Channel existence
- Presence
- Deferred
- Client events
- Cache channels
- Subscription count

## Setup

This section has instructions for collecting logs for the Sumo Logic's Pusher webhook collection.

### Source configuration
Follow the below steps to configure the Hosted Collector to receive Pusher events:

1. In the Sumo Logic portal, create a new [Hosted Collector](https://help.sumologic.com/docs/send-data/hosted-collectors/configure-hosted-collector/) or use an existing one. Then add a [HTTP Logs and Metrics Source](https://help.sumologic.com/docs/send-data/hosted-collectors/http-source/logs-metrics/#configure-an-httplogs-and-metrics-source).
2. Configure **Source Category** in the HTTP Source. For example, configure as `webhook/pusher` for the Pusher integration.
3. Copy and save the endpoint URL of the source.
### Vendor configuration
Configure the webhook integration in Pusher to send events to the Sumo Logic HTTP source. Once configured, it will be triggered each time the events occur within your Pusher account.

Follow the below steps to configure the Pusher webhook:

1. Sign in to your [Pusher account](https://dashboard.pusher.com/accounts/sign_in).
2. In the left navigation panel, Select your channel from the **Channels** tile.
3. Select **Webhooks**.
4. Click on **Add webhook**. The webhook's configuration page will appear.
5. Enter webhook form data as follows:
- **Webhook URL**. Enter the Sumo Logic HTTP endpoint URL(source address) created above.
- **Event type**. Select specific event type you want the webhook to trigger for.
6. Click on **Save**.
7. Verify Pusher events are getting ingested in Sumo Logic by executing the following query on Sumo Logic's search panel.
`_sourcecategory=webhook/pusher`

:::info
- For detailed information about webhook creation, refer [Pusher Documentation](https://pusher.com/docs/channels/server_api/webhooks/).
- For support, contact [Pusher](https://support.pusher.com/hc/en-us).
:::
56 changes: 56 additions & 0 deletions docs/integrations/webhooks/rollbar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
id: rollbar
title: Rollbar
description: Learn about the collection process for the Rollbar integration.
---
import useBaseUrl from '@docusaurus/useBaseUrl';

<img src={useBaseUrl('img/integrations/webhooks/rollbar-logo.png')} alt="Thumbnail icon" width="50"/>

Rollbar is an error tracking and monitoring platform that assists developers in identifying and resolving software issues quickly, enhancing application reliability. A webhook available in the Rollbar can forward events related to errors, occurrences, and activities from Rollbar platform to the Sumo Logic HTTP endpoint. Using these logs, you can monitor details such as error messages, stack traces, affected endpoints, user information, and environment variables in Sumo Logic. For more details, refer to the [Rollbar Documentation](https://docs.rollbar.com/docs).

## Event types

The Sumo Logic integration for Rollbar ingests Rollbar events into Sumo Logic through an outgoing webhook available in Rollbar. The following event types are ingested through the Rollbar webhook:
- 10^nth occurrence
kimsauce marked this conversation as resolved.
Show resolved Hide resolved
- Deploy
- Every occurrence
- High occurrence rate
- Item reactivated
- Item reopened
- Item resolved
- New item

## Setup

This section has instructions for collecting logs for the Sumo Logic's Rollbar webhook collection.

### Source configuration
Follow the below steps to configure the Hosted Collector to receive Rollbar events:

1. In the Sumo Logic portal, create a new [Hosted Collector](https://help.sumologic.com/docs/send-data/hosted-collectors/configure-hosted-collector/) or use an existing one. Then add a [HTTP Logs and Metrics Source](https://help.sumologic.com/docs/send-data/hosted-collectors/http-source/logs-metrics/#configure-an-httplogs-and-metrics-source).
2. Configure **Source Category** in the HTTP Source. For example, configure as `webhook/rollbar` for the Rollbar integration.
3. Copy and save the endpoint URL of the source.
### Vendor configuration
Configure the webhook integration in Rollbar to send events to the Sumo Logic HTTP source. Once configured, it will be triggered each time the events occur within your Rollbar account.

Follow the below steps to configure the Rollbar webhook:

1. Sign in to your [Rollbar account](https://rollbar.com/login/).
2. In the Rollbar dashboard, navigate to the project for which you want to set up the webhook from the **Projects** section.
3. Go to **Notifications** under the **Integrations** from the project settings.
4. Select **Webhook** from the **Available Channels**. The webhook form will appear.
5. Enter webhook form data as follows:
- **URL**. Enter the Sumo Logic HTTP endpoint URL(source address) created above.
6. Click **Enable Webhook Integration**. The webhook's configuration page will appear.
7. Select the rule to trigger the webhook from **Template** dropdown under the **Add Rule** section.
8. Click on **Configure Rule**. **Create Rule** table will appear.
9. Update the filters if required. Click on **Create Rule**.
10. Click on **Save Settings** to update the webhook configuration.
11. Verify Rollbar events are getting ingested in Sumo Logic by executing the following query on Sumo Logic's search panel.
`_sourcecategory=webhook/rollbar`

:::info
- For detailed information about webhook creation, refer [Rollbar Documentation](https://docs.rollbar.com/docs/webhooks#configuration).
- For support, contact [Rollbar](https://rollbar.com/contact/?inquiryType=Support).
:::
60 changes: 60 additions & 0 deletions docs/integrations/webhooks/sendgrid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
id: sendgrid
title: SendGrid
description: Learn about the collection process for the SendGrid integration.
---
import useBaseUrl from '@docusaurus/useBaseUrl';

<img src={useBaseUrl('img/integrations/webhooks/sendGrid-logo.png')} alt="Thumbnail icon" width="50"/>

SendGrid is a cloud-based email delivery and management platform that helps businesses send transactional and marketing emails reliably and efficiently. A webhook available in the SendGrid can forward events related to email actions from SendGrid platform to the Sumo Logic HTTP endpoint. Using these logs, you can monitor recipient engagement, track email delivery status, and respond to events like opens, clicks, bounces, unsubscribes, and spam reports in Sumo Logic. For more details, refer to the [SendGrid Documentation](https://docs.sendgrid.com/).

## Event types

The Sumo Logic integration for SendGrid ingests SendGrid deliverability events and engagement events into Sumo Logic through an outgoing webhook available in SendGrid. The following event types are ingested through the SendGrid webhook:
- Processed
- Dropped
- Deferred
- Bounced
- Delivered
- Opened
- Clicked
- Unsubscribed
- Spam Reports
- Group Unsubscribes
- Group Resubscribes

## Setup

This section has instructions for collecting logs for the Sumo Logic's SendGrid webhook collection.

### Source configuration
Follow the below steps to configure the Hosted Collector to receive SendGrid events:

1. In the Sumo Logic portal, create a new [Hosted Collector](https://help.sumologic.com/docs/send-data/hosted-collectors/configure-hosted-collector/) or use an existing one. Then add a [HTTP Logs and Metrics Source](https://help.sumologic.com/docs/send-data/hosted-collectors/http-source/logs-metrics/#configure-an-httplogs-and-metrics-source).
2. Configure **Source Category** in the HTTP Source. For example, configure as `webhook/sendgrid` for the SendGrid integration.
3. Copy and save the endpoint URL of the source.
### Vendor configuration
Configure the webhook integration in SendGrid to send events to the Sumo Logic HTTP source. Once configured, it will be triggered each time the events occur within your SendGrid account.

Follow the below steps to configure the SendGrid Webhook:

1. Sign in to your [SendGrid account](https://app.sendgrid.com/login).
2. Navigate to **Mail Settings** from the **Settings** section.
3. Click on **Event Webhooks** under the **Webhook Settings**.
4. Click on **Create new webhook**. The webhook's configuration page will appear.
5. Enter webhook form data as follows:
- **Enabled**. Toggle to make webhook active.
- **Friendly Name**. Enter an optional name to help you differentiate among your webhooks.
- **Post URL**. Enter the Sumo Logic HTTP endpoint URL(source address) created above.
- **Actions to be posted**. Select the event types you would like to receive data about from webhook.
- **Security features**. See [Event Webhook Security Features](https://docs.sendgrid.com/for-developers/tracking-events/getting-started-event-webhook-security-features) for details about configuring the settings under this heading.
- **Test Your Integration**. select to receive an HTTP POST request with example events as a JSON array at your provided Post URL.
6. Click on **Save**.
7. Verify SendGrid events are getting ingested in Sumo Logic by executing the following query on Sumo Logic's search panel.
`_sourcecategory=webhook/sendgrid`

:::info
- For detailed information about webhook creation, refer [SendGrid Documentation](https://docs.sendgrid.com/for-developers/tracking-events/getting-started-event-webhook).
- For support, contact [SendGrid](https://support.sendgrid.com/hc/en-us).
:::
52 changes: 52 additions & 0 deletions docs/integrations/webhooks/sentry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
id: sentry
title: Sentry
description: Learn about the collection process for the Sentry integration.
---
import useBaseUrl from '@docusaurus/useBaseUrl';

<img src={useBaseUrl('img/integrations/webhooks/sentry-logo.png')} alt="Thumbnail icon" width="50"/>

Sentry is an open-source error monitoring platform that helps developers identify, track, and resolve software issues in real-time, enhancing the stability and reliability of applications and websites. A webhook available in the Sentry can forward events from Sentry platform to the Sumo Logic HTTP endpoint. Using these logs, you can monitor installations, received issues, metric alerts, tracked issues, and identified errors in Sumo Logic. For more details, refer to the [Sentry Documentation](https://docs.sentry.io/).

## Event types

The Sumo Logic Integration for Sentry ingests Sentry events into Sumo Logic through an outgoing webhook available in Sentry. Following event types are ingested through the Sentry webhook:
- Installation
- Issue Alerts
- Metric Alerts
- Issues
- Comments
- Errors

## Setup

This section has instructions for collecting logs for the Sumo Logic's Sentry webhook collection.

### Source configuration
Follow the below steps to configure the Hosted Collector to receive Sentry events:

1. In the Sumo Logic portal, create a new [Hosted Collector](https://help.sumologic.com/docs/send-data/hosted-collectors/configure-hosted-collector/) or use an existing one. Then add a [HTTP Logs and Metrics Source](https://help.sumologic.com/docs/send-data/hosted-collectors/http-source/logs-metrics/#configure-an-httplogs-and-metrics-source).
2. Configure **Source Category** in the HTTP Source. For example, configure as `webhook/sentry` for the Sentry integration.
3. Copy and save the endpoint URL of the source.
### Vendor configuration
Configure the webhook integration in Sentry to send events to the Sumo Logic HTTP source. Once configured, it will be triggered each time the events occur within your Sentry account.

Follow the below steps to configure the Sentry Webhook:

1. Sign in to your [Sentry account](https://sentry.io/auth/login/).
2. Click on **Settings**.
3. Select **Integrations** under the **Organization** section.
4. Select **Webhooks**.
5. Click on **Add to Project** and select a project to continue from list of projects. The webhook's configuration page will appear.
6. Enter webhook form data as follows:
- **Callback URLs**. Enter the Sumo Logic HTTP Source Address created above.
7. Click on **Save Changes**.
8. Click on **Enale Plugin**.
9. Verify Sentry events are getting ingested in Sumo Logic by executing the following query on Sumo Logic's search panel.
`_sourcecategory=webhook/sentry`

:::info
- For detailed information about webhook creation, refer [Sentry Documentation](https://docs.sentry.io/product/integrations/integration-platform/webhooks/).
- For support, contact [Sentry](https://help.sentry.io/).
:::
Loading