GET
/
integration
/
config
/
{type}
Get integration configuration by type
curl --request GET \
  --url https://api.wirespeed.co/integration/config/{type}
{
  "authType": "oauth2",
  "name": "<string>",
  "oauthRequiresRedirect": true,
  "customFields": [
    {
      "slug": "<string>",
      "display": "<string>",
      "type": "<string>",
      "required": true,
      "description": "<string>",
      "validationPattern": "<string>",
      "validationMinLength": 123,
      "validationMaxLength": 123,
      "source": "<string>",
      "advancedOption": true
    }
  ],
  "requiresConfiguration": true,
  "logo": "<string>",
  "logoLight": "<string>",
  "logoDark": "<string>",
  "beta": true,
  "description": "<string>",
  "slug": "<string>",
  "internalCreds": true,
  "docsUrl": "<string>",
  "default": true,
  "rtfm": true,
  "useCases": [
    "chat_ops"
  ],
  "webhookActions": [
    {
      "slug": "<string>",
      "display": "<string>",
      "description": "<string>",
      "useCases": [
        "chat_ops"
      ]
    }
  ]
}

Path Parameters

type
string
required

Integration type

Response

authType
enum<string>
required

Authentication type for the integration

Available options:
oauth2,
api_token,
basic,
other
name
string
required

Display name of the integration

customFields
object[]
required

Custom configuration fields for the integration

URL of the integration logo

logoLight
string
required

URL of the light theme logo

logoDark
string
required

URL of the dark theme logo

beta
boolean
required

Whether this integration is in beta

description
string
required

Description of the integration

slug
string
required

Unique slug identifier for the integration

internalCreds
boolean
required

Whether credentials are managed internally

docsUrl
string
required

URL to integration documentation

default
boolean
required

Whether this is a default integration

rtfm
boolean
required

Should the instructions be read before continuing with this integration?

useCases
enum<string>[]
required

Use cases for the integration

webhookActions
object[]
required

Available actions for this integration

oauthRequiresRedirect
boolean

Whether OAuth flow requires a redirect

requiresConfiguration
boolean

Whether the integration requires additional configuration