> Documentation index for AI agents: https://docs.pagerduty.com/llms.txt # List Workflow Integrations `GET https://api.pagerduty.com/workflows/integrations` List available Workflow Integrations. Scoped OAuth requires: `workflow_integrations.read` ## Authorization - **api_key** (apiKey) — `Authorization` header. The API Key with format `Token token=` ## Query parameters | Name | Type | Required | Description | |---|---|---|---| | `limit` | integer | | The minimum of the `limit` parameter used in the request or the maximum request size of the API. | | `cursor` | string | | Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. | | `include_deprecated` | boolean | | Whether to include deprecated Integrations in the response. Default: `false`. | ## Header parameters | Name | Type | Required | Description | |---|---|---|---| | `Accept` | string | yes | The `Accept` header is used as a versioning header. Default: `application/vnd.pagerduty+json;version=2`. | ## Response 200 A paginated list of Workflow Integrations. ### `application/json` | Field | Type | Required | Description | |---|---|---|---| | `limit` | integer | yes | | | `next_cursor` | string \| null | yes | | | `integrations` | array of object | yes | | | `integrations[].id` | string | | The ID of the integration. Read-only. | | `integrations[].summary` | string \| null | | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. Read-only. | | `integrations[].type` | string | | The type of the resource. Read-only. | | `integrations[].self` | string \| null (url) | | the API show URL at which the object is accessible. Read-only. | | `integrations[].html_url` | string \| null (url) | | a URL at which the entity is uniquely displayed in the Web app. Read-only. | | `integrations[].domain_name` | string | | Will be pagerduty.com. | | `integrations[].package_name` | string | | The package that the integration is part of. | | `integrations[].name` | string | | The name of the integration. | | `integrations[].description` | string | | The description of the integration. | | `integrations[].icon_svg` | string | | The svg string of the icon for the integration. | | `integrations[].tags` | array of string | | A list of tags applied to the integration. | | `integrations[].search_keywords` | array of string | | A list of keywords that match this integration. | | `integrations[].is_deprecated` | boolean | | Whether or not the integration is deprecated. | | `integrations[].entitled` | boolean | | Whether or not the integration is entitled. | | `integrations[].application` | string | | The application that this integration is associated with. | | `integrations[].configuration_schema` | object | | The JSON schema for the configuration of the integration. This is a dynamic field and is different for every integration. | | `integrations[].secrets_schema` | object | | The JSON schema for the secrets of the integration. This is a dynamic field and is different for every integration. | | `integrations[].created_at` | string (date-time) | | Read-only. | | `integrations[].created_by` | object, nullable | | Reference to the user who created this connection. Read-only. | | `integrations[].created_by.type` | string | | Type of the referenced object. Read-only. One of: `user_reference`. | | `integrations[].created_by.id` | string | | Unique identifier of the user. Read-only. | | `integrations[].created_by.summary` | string | | The user's name. Read-only. | | `integrations[].created_by.html_url` | string (url) | | a URL at which the entity is uniquely displayed in the Web app. Read-only. | | `integrations[].created_by.self` | string (url) | | the API show URL at which the object is accessible. Read-only. | Example: Response Example ```json { "integrations": [ { "id": "http-api", "type": "workflow_integration", "domain_name": "pagerduty.com", "package_name": "http-api", "name": "Web API", "description": "Create fast, custom connections to apps without integrations.", "icon_svg": "\n\n\n", "tags": [ "integration" ], "search_keywords": [ "web", "api", "rest", "http", "headers" ], "is_deprecated": false, "entitled": true, "application": null, "configuration_schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://api.pagerduty.com/workflows/integrations/http-api/schemas/configuration.json", "title": "Web API Integration Configuration", "description": "The configuration of a workflow integration connection to Web API", "type": "object", "properties": { "Redacted Authentication Headers": { "type": "text", "description": "Stores the redacted versions of the sensitive authentication headers", "is_hidden": true, "advanced": false, "metadata": "", "default_value": null, "restrictions": null, "display_order": 2 }, "Allowed Hostnames": { "type": "text", "description": "Enter the hostnames to allow sending these credentials to, one per line. An asterisk (*) may be used for subdomains. Ex: \"example.com\", \"subdomain.example.com\" or \"*.example.com\"", "is_hidden": false, "advanced": false, "metadata": "{\"format\":\"textarea\"}", "default_value": null, "restrictions": null, "display_order": 3, "format": "TEXTAREA" }, "Health Check URL": { "type": "text", "description": "Enter a url to monitor the health of this connection.", "is_hidden": false, "advanced": false, "metadata": "", "default_value": null, "restrictions": null, "display_order": 4 }, "Health Check Method": { "type": "singleChoice", "description": "Select which HTTP method to use for the health check request.", "is_hidden": false, "advanced": false, "metadata": "", "default_value": "HEAD", "restrictions": { "choices": [ "HEAD", "GET" ] }, "display_order": 5 }, "Existing Connection": { "type": "connection", "description": "Existing connection to update, if any", "is_hidden": true, "advanced": false, "metadata": "", "default_value": null, "restrictions": null, "display_order": 6, "connection_type_id": "pagerduty.com:http-api:integration:1" } }, "required": [ "Allowed Hostnames" ] }, "secrets_schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://api.pagerduty.com/workflows/integrations/http-api/schemas/secrets.json", "title": "Web API Integration Secrets", "description": "The secrets of a workflow integration connection to Web API", "type": "object", "properties": { "Authentication Headers": { "type": "text", "description": "Enter the headers to include in Web API calls made with this connection, one per line. Ex: \"Authorization: Bearer XXXX\"", "is_hidden": false, "advanced": false, "metadata": "{\"format\":\"textarea\"}", "default_value": null, "restrictions": null, "display_order": 1, "format": "TEXTAREA" }, "required": [ "Authentication Headers" ] } }, "html_url": "https://subdomain.pagerduty.com/workflows/integrations/http-api", "self": "https://api.pagerduty.com/workflows/integrations/http-api", "created_at": "2024-06-18T18:41:27.1+00:00", "created_by": { "id": "P7F68N8", "type": "user_reference", "summary": "John Smith", "html_url": "https://subdomain.pagerduty.com/users/P7F68N8", "self": "https://api.pagerduty.com/users/P7F68N8" } } ], "limit": 10, "next_cursor": "WyJtM2RlbW8ucGQtc3RhZ2luZy5jb206Z2l0aHViOmludGVncmF0aW9uOjMiXQ==" } ``` ## Response 400 Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. ### `application/json` | Field | Type | Required | Description | |---|---|---|---| | `error` | object | | | | `error.code` | integer | | Read-only. | | `error.message` | string | | Error message string. Read-only. | | `error.errors` | array of string | | Read-only. | ## Response 401 Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed. ### `application/json` | Field | Type | Required | Description | |---|---|---|---| | `error` | object | | | | `error.code` | integer | | Read-only. | | `error.message` | string | | Error message string. Read-only. | | `error.errors` | array of string | | Read-only. | ## Response 403 Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action. ### `application/json` | Field | Type | Required | Description | |---|---|---|---| | `error` | object | | | | `error.code` | integer | | Read-only. | | `error.message` | string | | Error message string. Read-only. | | `error.errors` | array of string | | Read-only. | ## Response 404 The requested resource was not found. ### `application/json` | Field | Type | Required | Description | |---|---|---|---| | `error` | object | | | | `error.code` | integer | | Read-only. | | `error.message` | string | | Error message string. Read-only. | | `error.errors` | array of string | | Read-only. | ## Response 429 Too many requests have been made, the rate limit has been reached. ### `application/json` | Field | Type | Required | Description | |---|---|---|---| | `error` | object | | | | `error.code` | integer | | Read-only. | | `error.message` | string | | Error message string. Read-only. | | `error.errors` | array of string | | Read-only. | ## Developer Agreement Your access to and use of the PagerDuty Developer Services is governed by the [PagerDuty Developer Agreement](https://docs.pagerduty.com/developer/pagerduty-developer-agreement).