ByteChef LogoByteChef
Components

PagerDuty

With PagerDuty, you can get real-time alerts, manage on-call schedules, and automate parts of your incident response process.

Categories: Project Management

Type: pagerDuty/v1

Connections

Version: 1

custom

Properties

NameLabelTypeDescriptionRequired
api_keyAPI KeySTRINGEnter your API Key. Can be found in Integrations -> API Access Keys.true

Actions

Create Incident

Name: createIncident

Create an incident synchronously without a corresponding event from a monitoring service.

Properties

NameLabelTypeDescriptionRequired
FromFromSTRINGThe email address of a valid user associated with the account making the request.true
titleTitleSTRINGA short description of the nature, symptoms, cause, or effect of the incident.true
serviceServiceSTRINGThe incident will be created on this service.true
priorityPrioritySTRINGPriority of the incident. Priorities must be enabled in your PagerDuty account in order to use them.false
urgencyUrgencySTRING
Options high, low
The urgency level of this incident.false
detailsDetailsSTRINGDetails about the incident.false
assignmentsAssignmentsARRAY
Items [STRING($assignee)]
Assign the incident to these assignees.false
incident_keyIncident KeySTRINGA string which identifies the incident.false
incident_typeIncident TypeSTRINGIncident type.false
escalation_policyEscalation PolicySTRINGDelegate this incident to the specified escalation policy. Cannot be specified if an assignee is given.false

Example JSON Structure

{
  "label" : "Create Incident",
  "name" : "createIncident",
  "parameters" : {
    "From" : "",
    "title" : "",
    "service" : "",
    "priority" : "",
    "urgency" : "",
    "details" : "",
    "assignments" : [ "" ],
    "incident_key" : "",
    "incident_type" : "",
    "escalation_policy" : ""
  },
  "type" : "pagerDuty/v1/createIncident"
}

Output

Type: OBJECT

Properties

NameTypeDescription
incidentOBJECT
Properties {INTEGER(incident_number), STRING(title), STRING(description), STRING(created_at), STRING(updated_at), STRING(status), STRING(incident_key), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}(service), [{STRING(at), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}(assignee)}](assignments), STRING(assigned_via), STRING(last_status_change_at), STRING(resolved_at), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}(first_trigger_log_entry), {INTEGER(all), INTEGER(triggered), INTEGER(resolved)}(alert_counts), BOOLEAN(is_mergeable), {STRING(name)}(incident_type), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}(escalation_policy), [](teams), [{STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}($service)](impacted_services), [](pending_actions), [](acknowledgements), STRING(basic_alert_grouping), STRING(alert_grouping), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}(last_status_changed_by), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url), STRING(account_id), STRING(color), STRING(created_at), STRING(description), STRING(name), INTEGER(order), INTEGER(schema_version), STRING(updated_at)}(priority), [](incidents_responders), [](responder_requests), [](subscriber_requests), STRING(urgency), STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}

Output Example

{
  "incident" : {
    "incident_number" : 1,
    "title" : "",
    "description" : "",
    "created_at" : "",
    "updated_at" : "",
    "status" : "",
    "incident_key" : "",
    "service" : {
      "id" : "",
      "type" : "",
      "summary" : "",
      "self" : "",
      "html_url" : ""
    },
    "assignments" : [ {
      "at" : "",
      "assignee" : {
        "id" : "",
        "type" : "",
        "summary" : "",
        "self" : "",
        "html_url" : ""
      }
    } ],
    "assigned_via" : "",
    "last_status_change_at" : "",
    "resolved_at" : "",
    "first_trigger_log_entry" : {
      "id" : "",
      "type" : "",
      "summary" : "",
      "self" : "",
      "html_url" : ""
    },
    "alert_counts" : {
      "all" : 1,
      "triggered" : 1,
      "resolved" : 1
    },
    "is_mergeable" : false,
    "incident_type" : {
      "name" : ""
    },
    "escalation_policy" : {
      "id" : "",
      "type" : "",
      "summary" : "",
      "self" : "",
      "html_url" : ""
    },
    "teams" : [ ],
    "impacted_services" : [ {
      "id" : "",
      "type" : "",
      "summary" : "",
      "self" : "",
      "html_url" : ""
    } ],
    "pending_actions" : [ ],
    "acknowledgements" : [ ],
    "basic_alert_grouping" : "",
    "alert_grouping" : "",
    "last_status_changed_by" : {
      "id" : "",
      "type" : "",
      "summary" : "",
      "self" : "",
      "html_url" : ""
    },
    "priority" : {
      "id" : "",
      "type" : "",
      "summary" : "",
      "self" : "",
      "html_url" : "",
      "account_id" : "",
      "color" : "",
      "created_at" : "",
      "description" : "",
      "name" : "",
      "order" : 1,
      "schema_version" : 1,
      "updated_at" : ""
    },
    "incidents_responders" : [ ],
    "responder_requests" : [ ],
    "subscriber_requests" : [ ],
    "urgency" : "",
    "id" : "",
    "type" : "",
    "summary" : "",
    "self" : "",
    "html_url" : ""
  }
}

Create Incident Note

Name: createIncidentNote

Create a new note for the specified incident.

Properties

NameLabelTypeDescriptionRequired
FromFromSTRINGThe email address of a valid user associated with the account making the request.true
incidentIdIncident IDSTRINGID of the incident to which the note will be added.true
contentContentSTRINGContent of the incident note.true

Example JSON Structure

{
  "label" : "Create Incident Note",
  "name" : "createIncidentNote",
  "parameters" : {
    "From" : "",
    "incidentId" : "",
    "content" : ""
  },
  "type" : "pagerDuty/v1/createIncidentNote"
}

Output

Type: OBJECT

Properties

NameTypeDescription
noteOBJECT
Properties {STRING(id), {STRING(type), STRING(id), STRING(summary), STRING(self), STRING(html_url)}(user), {STRING(type), STRING(id), STRING(summary), STRING(self), STRING(html_url)}(channel), STRING(content), STRING(created_at)}

Output Example

{
  "note" : {
    "id" : "",
    "user" : {
      "type" : "",
      "id" : "",
      "summary" : "",
      "self" : "",
      "html_url" : ""
    },
    "channel" : {
      "type" : "",
      "id" : "",
      "summary" : "",
      "self" : "",
      "html_url" : ""
    },
    "content" : "",
    "created_at" : ""
  }
}

Update Incident

Name: updateIncident

Update selected incident.

Properties

NameLabelTypeDescriptionRequired
FromFromSTRINGThe email address of a valid user associated with the account making the request.true
incidentIdIncident IDSTRINGID of the incident to which the note will be added.true
incident_typeIncident TypeSTRINGIncident type.true
statusStatusSTRING
Options resolved, acknowledged
The new status of the incident.false
assignmentsAssignmentsARRAY
Items [STRING($assignee)]
Assign the incident to these assignees.false
resolutionResolutionSTRINGThe resolution for this incident.false
titleTitleSTRINGA short description of the nature, symptoms, cause, or effect of the incident.false
priorityPrioritySTRINGPriority of the incident. Priorities must be enabled in your PagerDuty account in order to use them.false
urgencyUrgencySTRING
Options high, low
The urgency level of this incident.false
escalation_policyEscalation PolicySTRINGDelegate this incident to the specified escalation policy. Cannot be specified if an assignee is given.false

Example JSON Structure

{
  "label" : "Update Incident",
  "name" : "updateIncident",
  "parameters" : {
    "From" : "",
    "incidentId" : "",
    "incident_type" : "",
    "status" : "",
    "assignments" : [ "" ],
    "resolution" : "",
    "title" : "",
    "priority" : "",
    "urgency" : "",
    "escalation_policy" : ""
  },
  "type" : "pagerDuty/v1/updateIncident"
}

Output

Type: OBJECT

Properties

NameTypeDescription
incidentOBJECT
Properties {INTEGER(incident_number), STRING(title), STRING(description), STRING(created_at), STRING(updated_at), STRING(status), STRING(incident_key), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}(service), [{STRING(at), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}(assignee)}](assignments), STRING(assigned_via), STRING(last_status_change_at), STRING(resolved_at), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}(first_trigger_log_entry), {INTEGER(all), INTEGER(triggered), INTEGER(resolved)}(alert_counts), BOOLEAN(is_mergeable), {STRING(name)}(incident_type), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}(escalation_policy), [](teams), [{STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}($service)](impacted_services), [](pending_actions), [](acknowledgements), STRING(basic_alert_grouping), STRING(alert_grouping), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}(last_status_changed_by), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url), STRING(account_id), STRING(color), STRING(created_at), STRING(description), STRING(name), INTEGER(order), INTEGER(schema_version), STRING(updated_at)}(priority), [](incidents_responders), [](responder_requests), [](subscriber_requests), STRING(urgency), STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}

Output Example

{
  "incident" : {
    "incident_number" : 1,
    "title" : "",
    "description" : "",
    "created_at" : "",
    "updated_at" : "",
    "status" : "",
    "incident_key" : "",
    "service" : {
      "id" : "",
      "type" : "",
      "summary" : "",
      "self" : "",
      "html_url" : ""
    },
    "assignments" : [ {
      "at" : "",
      "assignee" : {
        "id" : "",
        "type" : "",
        "summary" : "",
        "self" : "",
        "html_url" : ""
      }
    } ],
    "assigned_via" : "",
    "last_status_change_at" : "",
    "resolved_at" : "",
    "first_trigger_log_entry" : {
      "id" : "",
      "type" : "",
      "summary" : "",
      "self" : "",
      "html_url" : ""
    },
    "alert_counts" : {
      "all" : 1,
      "triggered" : 1,
      "resolved" : 1
    },
    "is_mergeable" : false,
    "incident_type" : {
      "name" : ""
    },
    "escalation_policy" : {
      "id" : "",
      "type" : "",
      "summary" : "",
      "self" : "",
      "html_url" : ""
    },
    "teams" : [ ],
    "impacted_services" : [ {
      "id" : "",
      "type" : "",
      "summary" : "",
      "self" : "",
      "html_url" : ""
    } ],
    "pending_actions" : [ ],
    "acknowledgements" : [ ],
    "basic_alert_grouping" : "",
    "alert_grouping" : "",
    "last_status_changed_by" : {
      "id" : "",
      "type" : "",
      "summary" : "",
      "self" : "",
      "html_url" : ""
    },
    "priority" : {
      "id" : "",
      "type" : "",
      "summary" : "",
      "self" : "",
      "html_url" : "",
      "account_id" : "",
      "color" : "",
      "created_at" : "",
      "description" : "",
      "name" : "",
      "order" : 1,
      "schema_version" : 1,
      "updated_at" : ""
    },
    "incidents_responders" : [ ],
    "responder_requests" : [ ],
    "subscriber_requests" : [ ],
    "urgency" : "",
    "id" : "",
    "type" : "",
    "summary" : "",
    "self" : "",
    "html_url" : ""
  }
}

Triggers

New or Updated Incident Trigger

Name: newOrUpdatedIncident

Triggers incident is created or updated.

Type: DYNAMIC_WEBHOOK

Properties

NameLabelTypeDescriptionRequired
serviceServiceSTRINGThe service that will be watched for the trigger event.true

Output

Type: OBJECT

Properties

NameTypeDescription
idSTRINGID of the incident that triggered the trigger.
event_typeSTRINGType of the event that triggered the trigger.
resource_typeSTRINGType of the resource that triggered the trigger.
occurred_atSTRINGWhen did the event occurred.
agentOBJECT
Properties {STRING(type), STRING(id), STRING(summary), STRING(self), STRING(html_url)}
Agent that triggered the event.
clientOBJECT
Properties {}
Client on which event occurred.
dataOBJECT
Properties {STRING(id), STRING(type), STRING(self), STRING(html_url), STRING(number), STRING(status), STRING(incident_key), STRING(created_at), STRING(title), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}(service), [{STRING(at), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}(assignee)}](assignees), {STRING(id), STRING(type), STRING(summary), STRING(self), STRING(html_url)}(escalation_policy), [](teams), STRING(priority), STRING(urgency), STRING(conference_bridge), STRING(resolve_reason), {STRING(name)}(incident_type)}
Data of the object that triggered the trigger.

JSON Example

{
  "label" : "New or Updated Incident Trigger",
  "name" : "newOrUpdatedIncident",
  "parameters" : {
    "service" : ""
  },
  "type" : "pagerDuty/v1/newOrUpdatedIncident"
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

Additional Instructions

GitHubEdit on GitHub

OpenAI

OpenAI is a research organization that aims to develop and direct artificial intelligence (AI) in ways that benefit humanity as a whole.

PDF Helper

null