PagerDuty + SYNQ Integration Benefits

Connecting PagerDuty with SYNQ enhances your incident management and alerting capabilities, ensuring data issues are handled swiftly. Key benefits include:

  • Instant Alerts: Get real-time notifications from PagerDuty when a data issue arises.
  • Quick Impact Assessment: Easily evaluate the downstream business impact of data issues (e.g., impacted data products) so your team can prioritize fixes.
  • Unified workflow: On-call responders are alerted immediately, enabling faster, more efficient resolutions that fit your existing workflows.

How it Works

  • Issues triggered in SYNQ (e.g., anomaly monitors or dbt tests) are sent to PagerDuty as alerts, including details about the downstream impact, an error message, and the activity log

All actions taken in either PagerDuty or SYNQ are automatically synced, so both tools are up-to-date.

Requirements

  • PagerDuty integrations require an Admin base role for account authorization. If you do not have this role, please contact an Admin or Account Owner within your organization to configure the integration.

Support

If you need help with this integration, please contact SYNQ in our shared Slack channel.

Integration Walkthrough

In PagerDuty

  1. There are two ways to integrate with PagerDuty: via Global Event Routing or on a PagerDuty Service. If you are adding this integration to an existing PagerDuty service, please skip to the Integrating with a PagerDuty Service section of this guide.

Integrating With Global Event Routing

Integrating with Global Event Routing enables you to route events to specific services based on the payload of the event from your tool. If you would like to learn more, please visit our article on Global Event Routing.

  1. From the Configuration menu, select Event Rules.
  2. On the Event Rules screen, click on the arrow next to Incoming Event Source to display the Integration key information. Copy your Integration Key. This is the same integration key you will use for any other tool you want to integrate with using event rules. When you have finished setting up the integration in your tool, you will return to this interface to specify how to route events from your tool to services in PagerDuty.

Integrating With a PagerDuty Service

  1. From the Configuration menu, select Services.
  2. There are two ways to add an integration to a service:
    • If you are adding your integration to an existing service: Click the name of the service you want to add the integration to. Then, select the Integrations tab and click the New Integration button.
    • If you are creating a new service for your integration: Please read our documentation in section Configuring Services and Integrations and follow the steps outlined in the Create a New Service section, selecting SYNQ as the Integration Type in step 4. Continue with the In SYNQ section (below) once you have finished these steps.
  3. Enter an Integration Name in the format monitoring-tool-service-name (e.g., SYNQ-warehouse-one-monitoring) and select SYNQ from the Integration Type menu.
  4. Click the Add Integration button to save your new integration. You will be redirected to the Integrations tab for your service.
  5. An Integration Key will be generated on this screen. Keep this key saved in a safe place, as it will be used when you configure the integration with SYNQ in the next section.

In SYNQ

  1. Head to the Settings tab
  2. Click Add integration
  3. Select PagerDuty Manual
  4. Enter the following
    • Integration name: The name of your integration (default is PagerDuty)
    • Sevice region: Select EU or US depending on your PagerDuty service
    • Integration key: This is the Integration Key linked to your PagerDuty service integration. You can find it by opening the Integrations tab within your PagerDuty service. It’s a 32-character code.
  5. Click Create
  6. Under Settings you’ll see your new PagerDuty integration

Syncing the status between PagerDuty and SYNQ

When taking the action in PagerDuty, the following markings apply:

  • Acknowledged: It will assign the status to Investigating in SYNQ
  • Resolved: It will assign the status to Fixed in SYNQ

When taking action in SYNQ, the following marking will apply

  • Investigating: It will assign the status to Acknowledged in PagerDuty
  • Fixed/Expected/No Action Needed: It will tell PagerDuty that the issue is resolved

Configuring it in SYNQ

  1. Ensure that the PagerDuty integration is working by navigating to settings
  2. To set up syncing, edit the PagerDuty integration and copy the Webhook URL. You’ll need this URL to configure the Webhook in PagerDuty. When creating a new PagerDuty integration, the Webhook URL will appear after on the integration page.

Configuring it in PagerDuty

Follow these steps to add a webhook for SYNQ:

  1. Go to Services, select the relevant service, and open the Integrations tab.
  2. Scroll to the bottom and click on the option to Add Webhooks to the service.
  3. Click New Webhook.
  4. Paste the Webhook URL you obtained from SYNQ, and add a description (e.g., SYNQ).
  5. Ensure all event subscriptions are selected.
  6. Click Add Webhook at the bottom of the page.
  7. (Optional) After the Webhook Subscription is created, PagerDuty will provide a secret to verify webhook payloads. Copy this secret and configure it in SYNQ (within the PagerDuty service integration) to authenticate events received through the webhook.