PUT
/
integration
/
api-key
Add API key integration
curl --request PUT \
  --url https://api.wirespeed.co/integration/api-key \
  --header 'Content-Type: application/json' \
  --data '{
  "apiKey": "<string>",
  "fields": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}'
{
  "id": "<string>",
  "platform": "microsoft-teams",
  "enabled": true,
  "teamId": "<string>",
  "teamName": "<string>",
  "config": {
    "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"
        ]
      }
    ]
  },
  "permissionsUpdateAvailable": true,
  "permissionUpdateExplanation": "<string>",
  "requiresConfiguration": "<string>",
  "identityFields": {}
}

Query Parameters

integration
enum<string>
required
Available options:
microsoft-teams,
google-alert-center,
reversing-labs,
jamf-protect,
jamf-pro,
thinkst-canary,
generic-json,
box,
hyas-protect,
checkpoint-harmony,
wirespeed,
wiz,
microsoft,
ipinfo,
cisco-umbrella,
jira-data-center,
windows-event-logs,
crowdstrike-falcon,
cisco-duo,
cisco-meraki,
fortianalyzer,
jira-cloud,
microsoft-entra,
have-i-been-pwned,
manage-engine-ad-audit-plus,
google-directory,
okta,
sentinel-one,
slack,
aws,
kandji,
wordfence,
generic-syslog,
cisco-catalyst,
connectwise-psa,
email,
fortinet

Body

application/json
fields
object[]
required

Additional fields for integration configuration

apiKey
string

API key for the integration

Response

id
string
required

Unique identifier for the integration

platform
enum<string>
required

Integration platform type

Available options:
microsoft-teams,
google-alert-center,
reversing-labs,
jamf-protect,
jamf-pro,
thinkst-canary,
generic-json,
box,
hyas-protect,
checkpoint-harmony,
wirespeed,
wiz,
microsoft,
ipinfo,
cisco-umbrella,
jira-data-center,
windows-event-logs,
crowdstrike-falcon,
cisco-duo,
cisco-meraki,
fortianalyzer,
jira-cloud,
microsoft-entra,
have-i-been-pwned,
manage-engine-ad-audit-plus,
google-directory,
okta,
sentinel-one,
slack,
aws,
kandji,
wordfence,
generic-syslog,
cisco-catalyst,
connectwise-psa,
email,
fortinet
enabled
boolean
required

Whether the integration is enabled

teamId
string
required

ID of the team that owns this integration

config
object
required

Integration configuration metadata

permissionsUpdateAvailable
boolean
required

Whether a permissions update is available for this integration

permissionUpdateExplanation
string
required

Explanation for why a permissions update is available

identityFields
object
required

Identity fields that uniquely identify this integration instance

teamName
string

Name of the team that owns this integration

requiresConfiguration
string

Whether the integration requires additional configuration