-
Notifications
You must be signed in to change notification settings - Fork 211
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
SUMO-227719: added documentation for first set of webhook apps (#2976)
* SUMO-227719: added documentation for first set of webhook apps * Update docs/integrations/webhooks/honeybadger.md * Update docs/integrations/webhooks/mailgun.md * Update docs/integrations/webhooks/neoload.md * Update docs/integrations/webhooks/netlify.md * Update docs/integrations/webhooks/netlify.md --------- Co-authored-by: Kim <56411016+kimsauce@users.noreply.github.com> Co-authored-by: John Pipkin (Sumo Logic) <jpipkin@sumologic.com>
- Loading branch information
3 people
authored
Aug 24, 2023
1 parent
67ac349
commit 3783d9e
Showing
35 changed files
with
963 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| id: bugsnag | ||
| title: Bugsnag | ||
| description: Learn about the collection process for the Sumo Logic Bugsnag integration. | ||
| --- | ||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <img src={useBaseUrl('img/integrations/webhooks/bugsnag-logo.png')} alt="Thumbnail icon" width="50"/> | ||
|
|
||
| Bugsnag provides software teams with an automated crash detection platform for their web and mobile applications. You can use a webhook in the Bugsnag platform to forward error-related events to the Sumo Logic HTTP endpoint. Using these logs, you can monitor various events such as spikes in errors, new releases, error occurrences, frequent error patterns, milestones reached, collaborator interactions, and state changes in Sumo Logic. For more details, refer to the [Bugsnag Documentation](https://docs.bugsnag.com/). | ||
|
|
||
| ## Event types | ||
|
|
||
| The Sumo Logic integration for Bugsnag ingests error-related events into Sumo Logic through an outgoing webhook available in Bugsnag. The following event types are ingested through the Bugsnag webhook: | ||
| - Spikes in errors | ||
| - New releases | ||
| - Error occurrences | ||
| - Frequent error patterns | ||
| - Milestones reached | ||
| - Collaborator interactions | ||
| - State changes | ||
|
|
||
| ## Setup | ||
|
|
||
| This section has instructions for collecting logs for the Sumo Logic Bugsnag webhook collection. | ||
|
|
||
| ### Source configuration | ||
|
|
||
| Follow the below steps to configure the Hosted Collector to receive Bugsnag events: | ||
|
|
||
| 1. In the Sumo Logic portal, create a new [Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector/) or use an existing one. Then add an [HTTP Logs and Metrics Source](/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, `webhook/bugsnag` - for the Bugsnag integration. | ||
| 3. Copy and save the endpoint URL of the source. | ||
|
|
||
| ### Vendor configuration | ||
|
|
||
| Configure the webhook integration in Bugsnag to send events to the Sumo Logic HTTP source. Once configured, it will be triggered each time the events occur within your Bugsnag account. | ||
|
|
||
| Follow the steps to configure the Bugsnag webhook. | ||
|
|
||
| 1. Sign in to the [Bugsnag account](https://app.bugsnag.com/user/sign_in). | ||
| 2. Go to **Settings** icon on the right side of the navigation bar and select **Project settings**. | ||
| 3. Select **Data forwarding** under **Integrations and email** section. | ||
| 4. Select **Webhook** under **Available integrations**. | ||
| 6. Enter webhook form data as follows: | ||
| - **Webhook URL**. Enter the Sumo Logic HTTP endpoint URL (source address) created above. | ||
| 7. Click **SAVE**. | ||
| 8. Under **Notify me when** section, enable the event types for which you want to send notifications to Sumo Logic. | ||
| 9. Verify Bugsnag events are getting ingested in Sumo Logic by executing the following query on Sumo Logic's Log Search panel. | ||
| ```sql | ||
| `_sourcecategory=webhook/bugsnag` | ||
| ``` | ||
|
|
||
| :::info | ||
| - For detailed information about webhook creation, refer to the [Bugsnag Documentation](https://docs.bugsnag.com/product/integrations/data-forwarding/webhook/). | ||
| - For support, [contact Bugsnag](https://docs.bugsnag.com/platforms/macos/support/). | ||
| ::: | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| --- | ||
| id: configcat | ||
| title: ConfigCat | ||
| description: Learn about the collection process for the Sumo Logic ConfigCat integration. | ||
| --- | ||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <img src={useBaseUrl('img/integrations/webhooks/configcat-logo.png')} alt="Thumbnail icon" width="50"/> | ||
|
|
||
| ConfigCat is a hosted service for feature flag and configuration management. You can use a webhook in the ConfigCat platform to forward events related to feature flags and configuration changes to the Sumo Logic HTTP endpoint. Using these logs, you can monitor the entire lifecycle of their system, from the creation and updates of flags, settings, rules, and environments in Sumo Logic. For more details, refer to the [ConfigCat Documentation](https://configcat.com/docs/getting-started/). | ||
|
|
||
| ## Event types | ||
|
|
||
| The Sumo Logic integration for ConfigCat ingests feature flags and configuration changes events into Sumo Logic through an outgoing webhook available in ConfigCat. The following event types are ingested through the ConfigCat webhook: | ||
| - Flag Created | ||
| - Flag Updated | ||
| - Flag Deleted | ||
| - Setting Created | ||
| - Setting Updated | ||
| - Setting Deleted | ||
| - Rule Created | ||
| - Rule Updated | ||
| - Rule Deleted | ||
| - Environment Created | ||
| - Environment Updated | ||
| - Environment Deleted | ||
|
|
||
| ## Setup | ||
|
|
||
| This section has instructions for collecting logs for the Sumo Logic ConfigCat webhook collection. | ||
|
|
||
| ### Source configuration | ||
|
|
||
| Follow the below steps to configure the Hosted Collector to receive ConfigCat events: | ||
|
|
||
| 1. In the Sumo Logic portal, create a new [Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector/) or use an existing one. Then add an [HTTP Logs and Metrics Source](/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, `webhook/configcat` - for the ConfigCat integration. | ||
| 3. Copy and save the endpoint URL of the source. | ||
|
|
||
| ### Vendor configuration | ||
|
|
||
| Configure the webhook integration in ConfigCat to send events to the Sumo Logic HTTP source. Once configured, it will be triggered whenever any configuration change occurs in your ConfigCat account. | ||
|
|
||
| Follow the steps to configure the ConfigCat webhook. | ||
|
|
||
| 1. Sign in to the [ConfigCat account](https://app.configcat.com/auth/signup). | ||
| 2. Expand your product by clicking the three dots on the right of the product name. | ||
| 3. Under this go to **Webhooks**. | ||
| 4. Click **Add Webhook**. The webhook form appears. | ||
| 5. Enter webhook form data as follows: | ||
| - Select the config and environment for which you want to trigger the webhook. | ||
| - **HTTP Method**. Choose POST. | ||
| - **URL**. Enter the Sumo Logic HTTP endpoint URL (source address) created above. | ||
| - **Request Body**. Select JSON and use the following body payload. | ||
| ```json | ||
| { | ||
| "ConfigName": "##ConfigName##", | ||
| "ConfigId": "##ConfigId##", | ||
| "EnvironmentName": "##EnvironmentName##", | ||
| "EnvironmentId ": "##EnvironmentId##", | ||
| "URL": "##URL##", | ||
| "ChangeNotes": "##ChangeNotes##", | ||
| "ChangeDetails": "##ChangeDetails##", | ||
| "ChangeDetailsTeams": "##ChangeDetailsTeams##" | ||
| } | ||
| ``` | ||
| 6. Click **Save Changes**. | ||
| 7. Verify ConfigCat events are getting ingested in Sumo Logic by executing the following query on Sumo Logic's Log Search panel. | ||
| ```sql | ||
| `_sourcecategory=webhook/configcat` | ||
| ``` | ||
|
|
||
| :::info | ||
| - For detailed information about webhook creation, refer to the [ConfigCat Documentation](https://configcat.com/docs/advanced/notifications-webhooks/). | ||
| - For support, [contact ConfigCat](https://configcat.com/support/). | ||
| ::: | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| id: emnify | ||
| title: EMnify | ||
| description: Learn about the collection process for the Sumo Logic EMnify integration. | ||
| --- | ||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <img src={useBaseUrl('img/integrations/webhooks/emnify-logo.png')} alt="Thumbnail icon" width="50"/> | ||
|
|
||
| EMnify is the leading cloud-building block for cellular communications in the IoT stack, connecting millions of IoT devices globally. You can use a webhook in the EMnify platform to forward system events to the Sumo Logic HTTP endpoint. Using these logs, you can monitor the authentication, lifecycle transition and configuration change events in Sumo Logic. For more details, refer to the [EMnify Documentation](https://docs.emnify.com/). | ||
|
|
||
| ## Event types | ||
|
|
||
| The Sumo Logic integration for EMnify ingests system events into Sumo Logic through an outgoing webhook available in EMnify. For more information on supported events that are ingested through the EMnify webhook, see the [EMnify Documentation](https://docs.emnify.com/system-events/event-types). | ||
|
|
||
| ## Setup | ||
|
|
||
| This section has instructions for collecting logs for the Sumo Logic EMnify webhook collection. | ||
|
|
||
| ### Source configuration | ||
|
|
||
| Follow the below steps to configure the Hosted Collector to receive EMnify events: | ||
|
|
||
| 1. In the Sumo Logic portal, create a new [Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector/) or use an existing one. Then add an [HTTP Logs and Metrics Source](/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, `webhook/emnify` - for the EMnify integration. | ||
| 3. Copy and save the endpoint URL of the source. | ||
|
|
||
| ### Vendor configuration | ||
|
|
||
| Configure the webhook integration in EMnify to send events to the Sumo Logic HTTP source. Once configured, it will be triggered each time the events occur within your EMnify account. | ||
|
|
||
| Follow the below steps to configure the EMnify webhook. | ||
|
|
||
| 1. Sign in to the [EMnify account](https://portal.emnify.com/sign/up). | ||
| 2. Go to **Integrations** section. | ||
| 3. Go to **Data Streams**, select **ADD NEW DATA STREAM**. | ||
| 4. Search **Webhook** and click **ADD**. The webhook form appears. | ||
| 5. Enter webhook form data as follows: | ||
| - **STREAM TYPE**. Select **Stream Events**. | ||
| - **EVENT OPTIONS**. Select **Stream all events**. | ||
| - **DESTINATION**. Enter the Sumo Logic HTTP endpoint URL (source address) created above. | ||
| 6. Click **CREATE**. | ||
| 7. Verify EMnify events are getting ingested in Sumo Logic by executing the following query on Sumo Logic's Log Search panel. | ||
| ```sql | ||
| `_sourcecategory=webhook/emnify` | ||
| ``` | ||
|
|
||
| :::info | ||
| - For support, [contact EMnify](https://www.emnify.com/premium-support). | ||
| ::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| id: firefly | ||
| title: Firefly | ||
| description: Learn about the collection process for the Sumo Logic Firefly integration. | ||
| --- | ||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <img src={useBaseUrl('img/integrations/webhooks/firefly-logo.png')} alt="Thumbnail icon" width="50"/> | ||
|
|
||
| Firefly's Cloud Asset Management solution enables DevOps, SREs, and platform engineering teams to control their entire cloud footprint and manage it more efficiently and consistently using Infrastructure-as-Code. You can use a webhook in the Firefly platform to forward events to the Sumo Logic HTTP endpoint. Using these logs, you can monitor the system for various events including drift detection, unmanaged resource detection, ghost resource detection, and policy violations in Sumo Logic. For more details, refer to the [Firefly Documentation](https://firefly-5.gitbook.io/firefly-documentation-portal/). | ||
|
|
||
| # Event types | ||
|
|
||
| The Sumo Logic integration for Firefly ingests events into Sumo Logic through an outgoing webhook available in Firefly. The following event types are ingested through the Firefly webhook: | ||
| - Drift Detection | ||
| - Unmanaged resource detection | ||
| - Ghost resource detection | ||
| - Policy Violation | ||
|
|
||
| # Setup | ||
|
|
||
| This section has instructions for collecting logs for the Sumo Logic Firefly webhook collection. | ||
|
|
||
| ### Source configuration | ||
|
|
||
| Follow the below steps to configure the Hosted Collector to receive Firefly events: | ||
|
|
||
| 1. In the Sumo Logic portal, create a new [Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector/) or use an existing one. Then add an [HTTP Logs and Metrics Source](/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, `webhook/firefly` - for the Firefly integration. | ||
| 3. Copy and save the endpoint URL of the source. | ||
|
|
||
| ### Vendor configuration | ||
|
|
||
| Configure the webhook integration in Firefly to send events to the Sumo Logic HTTP source. Once configured, it will be triggered each time the events occur within your Firefly account. | ||
|
|
||
| Follow the below steps to configure the Firefly webhook. | ||
|
|
||
| 1. Sign in to the [Firefly account](https://www.firefly.ai/). | ||
| 2. Go to **Settings**, and select **Integrations**. | ||
| 3. Click **Add New**. | ||
| 4. Under **Notifications** section, select **Webhooks**. The webhook form appears. | ||
| 5. Enter webhook form data as follows: | ||
| - **Nickname**. Provide a name for your webhook. | ||
| - **Webhook URL**. Enter the Sumo Logic HTTP endpoint URL (source address) created above. | ||
| 6. Click **Next**, and select **Done**. | ||
| 7. Go to **Notifications**, and click **Add New**. | ||
| 8. Enter notification form data as follows: | ||
| - **Event Type**. Select for which event type to receive a notification. | ||
| - Under **Criteria**, select the **Data source**. | ||
| - **Destination**. Select the webhook name created above. | ||
| 9. Click **Create**. | ||
| 10. Verify Firefly events are getting ingested in Sumo Logic by executing the following query on Sumo Logic's Log Search panel. | ||
| ```sql | ||
| `_sourcecategory=webhook/firefly` | ||
| ``` | ||
|
|
||
| :::info | ||
| - For detailed information about webhook creation, refer to the [Webhook Documentation](https://firefly-5.gitbook.io/firefly-documentation-portal/user-guides/integrations/integrate-your-providers-and-tools/send-firefly-notifications-to-your-messaging-tools/send-firefly-notifications-to-webhooks) and [Notification Documentation](https://firefly-5.gitbook.io/firefly-documentation-portal/user-guides/how-to-guides/manage-notifications). | ||
| - For support, [contact Firefly](https://firefly-5.gitbook.io/firefly-documentation-portal/contacting-firefly-support). | ||
| ::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| id: flagsmith | ||
| title: Flagsmith | ||
| description: Learn about the collection process for the Sumo Logic Flagsmith integration. | ||
| --- | ||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <img src={useBaseUrl('img/integrations/webhooks/flagsmith-logo.png')} alt="Thumbnail icon" width="50"/> | ||
|
|
||
| Flagsmith facilitates feature management across web, mobile, and server-side applications. You can use a webhook in the Flagsmith platform to forward feature-related events to the Sumo Logic HTTP endpoint. Using these logs, you can monitor the creation, updates, and overrides of features for identities and segment events in Sumo Logic. For more details, refer to the [Flagsmith Documentation](https://docs.flagsmith.com/). | ||
|
|
||
| ## Event types | ||
|
|
||
| The Sumo Logic integration for Flagsmith ingests feature events into Sumo Logic through an outgoing webhook available in Flagsmith. The following event types are ingested through the Flagsmith webhook: | ||
| - Feature Creation | ||
| - Feature Updates | ||
| - Feature Overrides | ||
|
|
||
| ## Setup | ||
|
|
||
| This section has instructions for collecting logs for the Sumo Logic Flagsmith webhook collection. | ||
|
|
||
| ### Source configuration | ||
|
|
||
| Follow the below steps to configure the Hosted Collector to receive Flagsmith events: | ||
|
|
||
| 1. In the Sumo Logic portal, create a new [Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector/) or use an existing one. Then add an [HTTP Logs and Metrics Source](/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, `webhook/flagsmith` - for the Flagsmith integration. | ||
| 3. Copy and save the endpoint URL of the source. | ||
|
|
||
| ### Vendor configuration | ||
|
|
||
| Configure the webhook integration in Flagsmith to send events to the Sumo Logic HTTP source. Once configured, it will be triggered each time the events occur within your Flagsmith account. | ||
|
|
||
| Follow the below steps to configure the Flagsmith webhook. | ||
|
|
||
| 1. Sign in to the [Flagsmith account](https://app.flagsmith.com/). | ||
| 2. Go to the project for which you want to send notifications to Sumo Logic. | ||
| 3. Select **Settings**, and move to **Webhooks**. | ||
| 4. Click **Create feature webhook**. The webhook form appears. | ||
| 5. Enter webhook form data as follows: | ||
| - **URL**. Enter the Sumo Logic HTTP endpoint URL (source address) created above. | ||
| 6. Click **Create Webhook**. | ||
| 7. Verify Flagsmith events are getting ingested in Sumo Logic by executing the following query on Sumo Logic's Log Search panel. | ||
| ```sql | ||
| `_sourcecategory=webhook/flagsmith` | ||
| ``` | ||
|
|
||
| :::info | ||
| - For detailed information about webhook creation, refer to the [Flagsmith Documentation](https://docs.flagsmith.com/integrations/webhook). | ||
| - For support, [contact Flagsmith](https://www.flagsmith.com/contact-us). | ||
| ::: |
Oops, something went wrong.