Update Workflow Integration Connection

Update an existing Workflow Integration Connection.

Scoped OAuth requires: workflow_integrations:connections.write

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Path Parameters

integration_id*string

The ID of the Workflow Integration

id*string

The ID of the resource.

Header Parameters

Accept*string

The Accept header is used as a versioning header.

Default"application/vnd.pagerduty+json;version=2"

Content-Type*"application/json"

Default"application/json"

Value in

"application/json"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Update a connection for a Workflow Integration

name*string

The name given to the connection

service_url?string

The URL of the service that this connection is associated with

external_id?string

The ID of the external system that this connection is used to connect to

external_id_label?string

The label of the external system that this connection is used to connect to

scopes?array<>

is_default?boolean

Whether or not this connection is the default connection for this integration

configuration?

The configuration for this connection. The configuration schema is defined in the Workflow Integration's configuration_schema property. It is dynamic based on the specific Workflow Integration.

secrets*

The secrets for this connection. The secrets schema is defined in the Workflow Integration's secrets_schema property. It is dynamic based on the specific Workflow Integration. This field is write-only and will always be null on a response so that secrets are not leaked.

teams?array<>

The teams whose managers are allowed to use or edit this connection

apps?array<>

The app IDs for this connection

Response Body

`application/json`

curl -X PATCH "https://example.com/workflows/integrations/{integration_id}/connections/{id}" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json" \  -H "Content-Type: application/json" \  -d '{    "connection": {      "name": "My Connection",      "service_url": "https://webhook.site",      "external_id": "My Connection",      "external_id_label": "Connection Name",      "configuration": {        "Health Check URL": "https://example.com/health",        "Allowed Hostnames": "webhook.site",        "Health Check Method": "GET"      },      "secrets": {        "Authentication Headers": "x-api-key: 1234abcd"      },      "is_default": true,      "teams": [],      "apps": []    }  }'

{  "connection": [    {      "id": "5a8e88bb-2acd-4035-8f02-163c10f917b8",      "type": "workflow_integration_connection",      "integration_id": "http-api",      "name": "My Connection",      "service_url": "https://webhook.site",      "external_id": "My Connection",      "external_id_label": "Connection Name",      "is_default": true,      "health": {        "is_healthy": true,        "last_checked_at": "2024-07-18T21:16:51.511+00:00",        "health_message": "Healthy"      },      "configuration": {        "Health Check URL": "https://example.com/health",        "Allowed Hostnames": "webhook.site",        "Health Check Method": "GET",        "Redacted Authentication Headers": "x-api-key: ****"      },      "secrets": null,      "teams": [],      "apps": [],      "html_url": "https://subdomain.pagerduty.com/workflows/integrations/http-api/connections/5a8e88bb-2acd-4035-8f02-163c10f917b8",      "self": "https://api.pagerduty.com/workflows/integrations/http-api/connections/5a8e88bb-2acd-4035-8f02-163c10f917b8",      "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"      }    }  ]}

Update Workflow Integration Connection

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`