WorkspaceIntegration

Create Workspace Integration

Changed on

Create Workspace Integration

post/integrations

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/integrations
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Request body

idstring

unique identifier

namestring

Human-friendly integration descriptor

integration_type'atlassian_connect' | 'atlassian_forge' | 'atlassian_rovo' | 'azure_boards' | 'export_feed_google_bigquery' | 'export_feed_google_cloud_storage' | 'export_feed_google_pubsub' | 'github_app' | 'jira' | 'jira_server_plugin' | 'microsoft_teams_webhook' | 'segment' | 'slack' | 'testrail' | 'xray' | 'xray_sync' | 'zephyr'
integration_categoriesstring[]
installation_idstring

a unique id that identifies this integration in the third party service, if applicable

claim_expiration_secondsinteger

length of time until this integration expires, if left unclaimed. Leaving this empty means there is no expiry.

workspace_idstring

Associated workspace

enabledboolean

Disable to stop running integration

encrypted_storestring

Encryption store to use for sensitive data

status'success' | 'error' | 'pending'

Last known integration state

status_reason'reconnect_required' nullable

Why status is error, when mabl knows. reconnect_required means the stored connection no longer works and the integration must be reconnected. Set by mabl; ignored on writes.

created_timeinteger

Time at which the insight was created

created_by_idstring

The ID of the user who created this insight

last_updated_timeinteger

time the insight was last updated

last_updated_by_idstring

The ID of the user who last updated this insight

Example request

{
  "config": {
    "issue_tracker": {
      "base_url": "https://jira.example.com/jira",
      "schemas": [
        {
          "fields": [
            {
              "id": "affected_platform",
              "name": "Affected Platform",
              "type": "labels",
              "allowed_values": [
                {
                  "value": "Chrome"
                },
                {
                  "value": "Edge"
                },
                {
                  "value": "Firefox"
                },
                {
                  "value": "IE11"
                },
                {
                  "value": "Safari"
                }
              ],
              "is_required": true
            }
          ]
        }
      ]
    }
  }
}

Response

Created Workspace Integration

idstring

unique identifier

namestring

Human-friendly integration descriptor

integration_type'atlassian_connect' | 'atlassian_forge' | 'atlassian_rovo' | 'azure_boards' | 'export_feed_google_bigquery' | 'export_feed_google_cloud_storage' | 'export_feed_google_pubsub' | 'github_app' | 'jira' | 'jira_server_plugin' | 'microsoft_teams_webhook' | 'segment' | 'slack' | 'testrail' | 'xray' | 'xray_sync' | 'zephyr'
integration_categoriesstring[]
installation_idstring

a unique id that identifies this integration in the third party service, if applicable

claim_expiration_secondsinteger

length of time until this integration expires, if left unclaimed. Leaving this empty means there is no expiry.

workspace_idstring

Associated workspace

enabledboolean

Disable to stop running integration

encrypted_storestring

Encryption store to use for sensitive data

status'success' | 'error' | 'pending'

Last known integration state

status_reason'reconnect_required' nullable

Why status is error, when mabl knows. reconnect_required means the stored connection no longer works and the integration must be reconnected. Set by mabl; ignored on writes.

created_timeinteger

Time at which the insight was created

created_by_idstring

The ID of the user who created this insight

last_updated_timeinteger

time the insight was last updated

last_updated_by_idstring

The ID of the user who last updated this insight

Example response

{
  "config": {
    "issue_tracker": {
      "base_url": "https://jira.example.com/jira",
      "schemas": [
        {
          "fields": [
            {
              "id": "affected_platform",
              "name": "Affected Platform",
              "type": "labels",
              "allowed_values": [
                {
                  "value": "Chrome"
                },
                {
                  "value": "Edge"
                },
                {
                  "value": "Firefox"
                },
                {
                  "value": "IE11"
                },
                {
                  "value": "Safari"
                }
              ],
              "is_required": true
            }
          ]
        }
      ]
    }
  }
}

Changes

  • 488eade0b398Revision changes
    • warning

      added the new zephyr enum value to the response property for the response status

    • info

      added the new optional request property /

    • info

      added the new zephyr enum value to the request property

    • info

      added the optional property / to the response with the status

  • 09076d803fdfRevision changes
    • info

      added the new optional request property //

    • info

      added the optional property // to the response with the status