v1

latestOpenAPI 3.1.1Productboard Proprietary2026-07-2453178243.2 KB
plugin-integrations

Update plugin integration

Partially updates a plugin integration. Fields not included in the request preserve their current value.

If the integration is enabled and fields.action.url is updated, Productboard sends a new probe to verify the updated endpoint. No probe is sent when disabled.

action is write-only: never returned in responses.

patch/plugin-integrations/{integrationId}

Path parameters

integrationIdstring uuid required
Example:00000000-0000-0000-0000-000000000001

UUID of the plugin integration.

Request body

Example request

{
  "data": {
    "fields": {
      "integrationStatus": "enabled",
      "name": "My Service Integration",
      "initialState": {
        "label": "Push"
      },
      "action": {
        "url": "https://example.com/productboard-push",
        "version": 1,
        "headers": {
          "authorization": "Bearer my-action-secret"
        }
      }
    }
  }
}

Response

Plugin integration updated successfully

Example response

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000001",
    "links": {
      "self": "https://api.productboard.com/v2/plugin-integrations/00000000-0000-0000-0000-000000000001",
      "connections": "https://api.productboard.com/v2/plugin-integrations/00000000-0000-0000-0000-000000000001/connections"
    }
  }
}