An integration is a representation of a connection between Flow and a vendor. Use this endpoint to retrieve information about the details and statuses of your integrations.
This endpoint has the following methods:
-
GET https://flow.pluralsight.com/v3/customer/core/integrations: Get a list of integrations and their associated information. -
GET https://flow.pluralsight.com/v3/customer/core/integrations/{id}: Get the information associated with a specific integration by ID. -
GET https://flow.pluralsight.com/v3/customer/core/integrations/{id}/connection_status: Get the integration data status associated with a specific integration by ID.
Parameters
| Name | Type | Description |
|---|---|---|
| id | double | Unique identifier for the integration. |
| name | string | Integration name. |
| org | double | Unique identifier for the organization. |
| vendor_type | string | Name of vendor. |
| auth_type | string | Authentication method. |
| webhooks_enabled | boolean | Returns true if webhooks are enabled. |
| enabled_source_types | string | An array of source types enabled for the integration (Repo, PRs, Tickets). |
| created_at | string | Date/time when the integration was created. |
| updated_at | string | Date/time when the integration was last updated. |
| created_by | string | User who created the integration. |
| updated_by | string | User who last updated the integration. |
| source_type_names | string | Names of enabled source types. |
| username | string | Username used to authenticate integration. |
| vendor_meta | string | An array of vendor information. |
| has_repos | boolean | Returns true if one or more repos exist. |
| excluded_project_owners | string | An array of excluded project owners/groups from the Repos available page. |
| url | string | Unused field |
| source_projects_last_updated | string | Date associated projects were last updated. |
| agent_enabled | boolean | Field reserved for future use. |
Example response
{
"id": 10649,
"name": "Engineering BB",
"org": 1234,
"vendor_type": "bitbucket",
"auth_type": "oauth",
"webhooks_enabled": false,
"auto_import_all_repo_groups_enabled": false,
"enabled_source_types": [
{
"id": 24894,
"status": "active",
"source_type_name": "pull_request",
"integration": 10649,
"source_type": 2,
"vendor_name": "bitbucket",
"created_by": "19994",
"agent_enabled": false
},
{
"id": 24895,
"status": "active",
"source_type_name": "ticket",
"integration": 10649,
"source_type": 1,
"vendor_name": "bitbucket",
"created_by": "19994",
"agent_enabled": false
},
{
"id": 24896,
"status": "active",
"source_type_name": "repo",
"integration": 10649,
"source_type": 3,
"vendor_name": "bitbucket",
"created_by": "19994",
"agent_enabled": false
}
],
"created_at": "2024-03-20T22:09:54.828795",
"updated_at": "2024-03-20T22:09:54.828815",
"created_by": {
"id": 19994,
"audit_created_at": "2020-01-10T15:21:38.635131",
"avatar_url": "https://secure.gravatar.com/avatar/example.jpg",
"is_active": true,
"saml_integration": null,
"login_email": "stephanie-ventura@examplecom",
"login_enabled": true,
"signup_method": "saml",
"needs_password_reset": false,
"password_change_allowed": false,
"user_id": 19994,
"name": "Stephanie Ventura",
"email": "stephanie-ventura@example.com",
"apex_user_id": 4458255
},
"updated_by": {
"id": 19994,
"audit_created_at": "2020-01-10T15:21:38.635131",
"avatar_url": "https://secure.gravatar.com/avatar/example.jpg",
"is_active": true,
"saml_integration": null,
"login_email": "stephanie-ventura@example.com",
"login_enabled": true,
"signup_method": "saml",
"needs_password_reset": false,
"password_change_allowed": false,
"user_id": 19994,
"name": "Stephanie Ventura",
"email": "stephanie-ventura@example.com",
"apex_user_id": 4458255
},
"source_type_names": [
"ticket",
"pull_request",
"repo"
],
"username": null,
"vendor_meta": {
"name": "bitbucket",
"title": "BitBucket Cloud",
"services": [
{
"name": "repo",
"display": "Repos"
},
{
"name": "ticket",
"display": "Tickets"
},
{
"name": "pull_request",
"display": "Pull Requests"
}
],
"icon": "vendors/bitbucket",
"auth_types": [
"oauth",
"userpass"
],
"is_cloud": true,
"enable_webhooks": true,
"allow_multiple_accounts": false
},
"has_repos": false,
"excluded_project_owners": [],
"url": "",
"api_url": null,
"source_projects_last_updated": null,
"integration_type": 1,
"processing_status": "UNPROCESSED",
"connected_accounts_count": 0,
"deployment_source": "none",
"exclusion_rule_count": 1,
"push_projects_enabled": false
}