Skip to main content
POST
/
v1
/
integrations
Create Integration
curl --request POST \
  --url https://api.getmaxim.ai/v1/integrations \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '
{
  "workspaceId": "<string>",
  "name": "<string>",
  "config": {
    "name": "<string>",
    "routingKey": "<string>",
    "webhookName": "<string>",
    "webhookUrl": "<string>",
    "dedupKey": "<string>"
  },
  "id": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "config": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://www.getmaxim.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-maxim-api-key
string
header
required

API key for authentication

Body

application/json
​
workspaceId
string
required

Unique identifier for the workspace

​
type
enum<string>
required

Type of integration (SLACK or PAGER_DUTY)

Available options:
SLACK,
PAGER_DUTY
​
name
string
required

Name of the integration

​
config
object
required

Integration-specific configuration

​
id
string

Unique identifier for the integration

Response

Integration created successfully

​
data
object
required