# Send data to PagerDuty

{% hint style="info" %}
See the changelog of the **PagerDuty** Data sink type [here](/data-sinks/pagerduty-data-sink.md).
{% endhint %}

## Overview

Onum supports integration with [PagerDuty](https://www.pagerduty.com/).

PagerDuty is a digital operations platform that helps teams manage and respond to critical incidents. It provides features like on-call scheduling, incident tracking, automated escalations, and integrations with various monitoring and alerting systems.

## Prerequisites 

You must create an **Events API V2 Integration** on the Service. This action generates a unique, 32-character **Integration Key** (**Routing Key**). This key is the essential credential for this sink.

## Onum Setup

{% stepper %}
{% step %}
Log in to your Onum tenant and click **Data Sinks> New Data sink**.
{% endstep %}

{% step %}
Double-click the **PagerDuty** Sink.
{% endstep %}

{% step %}
Enter a **Name** for the new Data Sink. Optionally, add a **Description** and some **Tags** to identify the Sink.
{% endstep %}

{% step %}
Decide whether or not to include this Data sink info in the metrics and graphs of the [**Home**](/the-workspace/home.md) area.
{% endstep %}

{% step %}
The **Routing Key**<mark style="color:red;">**\***</mark> is the **Integration Key**. Create a secret with this value or select one from your [Secrets](/administration/global-settings/tenant.md).&#x20;

Follow these steps to create a new routing key:

1. Log in to your PagerDuty account.
2. Go to the **Services** tab and select **Create a Service**.
3. Assign your **Escalation Policy**. For a heavier workload, we recommend the Events API to process Onum events and create new alerts/incidents, or update any that exist.
4. Create your **Service**.
5. Once the Service is created, you will be provided with an **Integration Key**. Copy this key for later.
   {% endstep %}

{% step %}
Click **New secret** to create a new one:

* Give the secret a **Name**.
* Turn off the **Expiration date** option.
* Click **Add new value** and paste the corresponding value.
* Click **Save**.

<figure><picture><source srcset="/files/NeeWsSQzoChVxRIY76Nt" media="(prefers-color-scheme: dark)"><img src="/files/1oTccyPmgZJ1laY7IhZH" alt=""></picture><figcaption></figcaption></figure>

{% hint style="info" %}
Learn more about secrets in Onum in [this article](/administration/global-settings/organization-settings/secrets-management.md).
{% endhint %}

You can now select the created secrets in the configuration.
{% endstep %}

{% step %}
Establish a limit for the **Maximum requests per second**<mark style="color:red;">**\***</mark>. The minimum value is `1` and the maximum value is `100`.
{% endstep %}

{% step %}
If you are using a proxy to establish the connection, toggle on the **Proxy configuration** button and enter the details here:

* **Scheme**<mark style="color:red;">**\***</mark>
* **Host**<mark style="color:red;">**\***</mark>
* **Port**<mark style="color:red;">**\***</mark>
* **Username**
* **Password**&#x20;
  {% endstep %}
  {% endstepper %}

Click **Finish** when complete. Your new Data sink will appear in the **Data sinks** area list.

### Pipeline configuration <a href="#pipeline-configuration" id="pipeline-configuration"></a>

When it comes to using this Data sink in a [Pipeline](https://docs.onum.com/the-workspace/pipelines), you must configure the following output parameters. To do it, simply click the Data sink on the canvas and select **Configuration**.

#### Output configuration <a href="#output-configuration" id="output-configuration"></a>

<table><thead><tr><th width="169.73046875">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Event action</strong><mark style="color:red;"><strong>*</strong></mark></td><td>Choose the input field from where to get the required action. The field values must be <code>trigger</code>, <code>acknowledge</code> or <code>resolve</code>.</td></tr></tbody></table>

#### Deduplication key

<table><thead><tr><th width="169.73046875">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Deduplication key</strong><mark style="color:red;"><strong>*</strong></mark></td><td>Choose the input field that contains the deduplication key.</td></tr></tbody></table>

#### Payload

<table><thead><tr><th width="169.73046875">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Summary</strong><mark style="color:red;"><strong>*</strong></mark></td><td>Choose the field that contains the alert description.</td></tr><tr><td><strong>Source</strong><mark style="color:red;"><strong>*</strong></mark></td><td>Choose the field that contains the unique location of the affected system, preferably a hostname or FQDN.</td></tr><tr><td><strong>Severity</strong><mark style="color:red;"><strong>*</strong></mark></td><td>Choose the field that contains the alert severity. The field values must<br>be <code>critical</code>, <code>error</code>, <code>warning</code> or <code>info</code>.</td></tr></tbody></table>

#### Advanced payload configuration

<table><thead><tr><th width="169.73046875">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Date</strong></td><td>Choose the field that contains the date on which the event was generated. Supported format is <code>YYYY-MM-DD HH:MM:SS</code></td></tr><tr><td><strong>Component</strong></td><td>Choose the field that contains the component of the source machine that is responsible, for example <code>mysql</code> or <code>eth0</code></td></tr><tr><td><strong>Group</strong></td><td>Choose the field that contains the logical grouping of components of the service, for example <code>app-stack</code></td></tr><tr><td><strong>Class</strong></td><td>Choose the field that contains the class/type of the event, for example <code>ping failure</code> or <code>cpu load</code></td></tr><tr><td><strong>Client</strong></td><td>Choose the field that contains the name of the monitoring client<br>that is triggering this event. This field is only used for triggering events.</td></tr><tr><td><strong>ClientURL</strong></td><td>Choose the field that contains the URL of the monitoring client that is triggering this event. This field is only used for triggering events.</td></tr><tr><td><strong>Details</strong></td><td>Choose the field that contains additional details about the event and affected system.</td></tr><tr><td><strong>Links</strong></td><td><p>Toggle the <strong>Links</strong> switch if you want to allow sending links and enter the following information:<br></p><ul><li><strong>href</strong><mark style="color:red;"><strong>*</strong></mark> - Choose the field that contains the required <code>href</code> attributes, that is, the URLs to be sent.</li><li><strong>text</strong> - Optionally, choose the field that contains the <code>text</code> attributes, that is, the visible text to be displayed.</li></ul></td></tr><tr><td><strong>Images</strong></td><td><p>Toggle the <strong>Images</strong> switch if you want to allow sending images and enter the following information:<br></p><ul><li><strong>src</strong><mark style="color:red;"><strong>*</strong></mark> - Choose the field that contains the required <code>src</code> attributes, that is, the image source URLs to be sent.</li><li><strong>href</strong> - Optionally, choose the field that contains the <code>href</code> attributes, that is, the destination URLs.</li><li><strong>alt</strong> - Choose the field that contains the required <code>alt</code> attributes, that is, the alternative text for images shown if the image doesn't load.</li></ul></td></tr></tbody></table>

Click **Save** to complete the process.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.onum.com/the-workspace/data-sinks/data-sink-integrations/send-data-to-pagerduty.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.