plugin-integration-connections
Get plugin integration connection
Returns the connection for a specific entity within a plugin integration.
Important: if no connection exists for the entity, this endpoint returns a connection with state: initial rather than a 404. The initial state indicates the entity has not yet been pushed to the third-party system.
get/plugin-integrations/{integrationId}/connections/{entityId}
Path parameters
integrationIdstring uuid required
Example:00000000-0000-0000-0000-000000000001
UUID of the plugin integration.
entityIdstring uuid required
Example:00000000-0000-0000-0000-000000000002
Entity identifier.
Response
Plugin integration connection details
Example response
{
"data": {
"id": "00000000-0000-0000-0000-000000000002",
"type": "pluginIntegrationConnection",
"fields": {
"connection": {
"label": "Done",
"hoverLabel": "Issue 123",
"tooltip": "Issue 123 - Implement XYZ",
"color": "green",
"targetUrl": "https://example.com/issues/123"
}
},
"links": {
"self": "https://api.productboard.com/v2/plugin-integrations/00000000-0000-0000-0000-000000000001/connections/00000000-0000-0000-0000-000000000002"
}
}
}