Create Integration

Header Parameters

x-workspace-id*string

Workspace ID

x-multiple-integrations?string

Whether the client supports bots with multiple instances of the same integration. Set to "true" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Request Body

application/json

Integration

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Name of the Integration

Lengthlength <= 200

version*string

Version of the Integration

Lengthlength <= 200

configuration?

Default configuration definition of the integration

configurations?

Additional configuration definitions of the integration

states?

events?

actions?

entities?

identifier?

channels?

user?

interfaces?

extraOperations?

EXPERIMENTAL Extra integration operations that should be sent or not to the integration instances. The key is the operation name.

sdkVersion?string

Lengthlength <= 200

secrets?

Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.

code?string

JavaScript code of the integration

url?string

URL of the integration

dev?boolean

Indicates if the integration is a development integration; Dev integrations run locally

icon?string

Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes.

readme?string

Base64 encoded markdown of the integration readme. The readme is specific to each integration versions.

title?string

Title of the integration. This is the name that will be displayed in the UI

Length1 <= length <= 64

description?string

Description of the integration. This is the description that will be displayed in the UI

Lengthlength <= 256

public?boolean

Deprecated

[DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.

visibility?string

The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.

Value in

"public"
"private"
"unlisted"

layers?array<string>

attributes?

Optional key-value attributes from the integration definition

Response Body

`application/json`

curl -X POST "https://example.com/v1/admin/integrations" \  -H "x-workspace-id: string" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "version": "string"  }'

{  "integration": {    "id": "stringstringstringstringstri",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "identifier": {      "fallbackHandlerScript": "string",      "extractScript": "string"    },    "sandbox": {      "identifierExtractScript": "string",      "messageExtractScript": "string"    },    "maxExecutionTime": 0,    "url": "string",    "signingSecret": "string",    "name": "string",    "version": "string",    "interfaces": {      "property1": {        "id": "stringstringstringstringstri",        "name": "string",        "version": "string",        "entities": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        },        "actions": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        },        "events": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        },        "channels": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        }      },      "property2": {        "id": "stringstringstringstringstri",        "name": "string",        "version": "string",        "entities": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        },        "actions": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        },        "events": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        },        "channels": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        }      }    },    "configuration": {      "title": "string",      "description": "string",      "identifier": {        "linkTemplateScript": "string",        "required": true      },      "schema": {}    },    "configurations": {      "property1": {        "title": "string",        "description": "string",        "identifier": {          "linkTemplateScript": "string",          "required": true        },        "schema": {}      },      "property2": {        "title": "string",        "description": "string",        "identifier": {          "linkTemplateScript": "string",          "required": true        },        "schema": {}      }    },    "channels": {      "property1": {        "title": "string",        "description": "string",        "messages": {          "property1": {            "schema": {}          },          "property2": {            "schema": {}          }        },        "conversation": {          "tags": {            "property1": {              "title": "string",              "description": "string"            },            "property2": {              "title": "string",              "description": "string"            }          },          "creation": {            "enabled": true,            "requiredTags": [              "string"            ]          }        },        "message": {          "tags": {            "property1": {              "title": "string",              "description": "string"            },            "property2": {              "title": "string",              "description": "string"            }          }        }      },      "property2": {        "title": "string",        "description": "string",        "messages": {          "property1": {            "schema": {}          },          "property2": {            "schema": {}          }        },        "conversation": {          "tags": {            "property1": {              "title": "string",              "description": "string"            },            "property2": {              "title": "string",              "description": "string"            }          },          "creation": {            "enabled": true,            "requiredTags": [              "string"            ]          }        },        "message": {          "tags": {            "property1": {              "title": "string",              "description": "string"            },            "property2": {              "title": "string",              "description": "string"            }          }        }      }    },    "states": {      "property1": {        "type": "conversation",        "schema": {}      },      "property2": {        "type": "conversation",        "schema": {}      }    },    "events": {      "property1": {        "title": "string",        "description": "string",        "schema": {},        "attributes": {          "property1": "string",          "property2": "string"        }      },      "property2": {        "title": "string",        "description": "string",        "schema": {},        "attributes": {          "property1": "string",          "property2": "string"        }      }    },    "actions": {      "property1": {        "title": "string",        "description": "string",        "billable": true,        "cacheable": true,        "input": {          "schema": {}        },        "output": {          "schema": {}        },        "attributes": {          "property1": "string",          "property2": "string"        }      },      "property2": {        "title": "string",        "description": "string",        "billable": true,        "cacheable": true,        "input": {          "schema": {}        },        "output": {          "schema": {}        },        "attributes": {          "property1": "string",          "property2": "string"        }      }    },    "user": {      "tags": {        "property1": {          "title": "string",          "description": "string"        },        "property2": {          "title": "string",          "description": "string"        }      },      "creation": {        "enabled": true,        "requiredTags": [          "string"        ]      }    },    "entities": {      "property1": {        "title": "string",        "description": "string",        "schema": {}      },      "property2": {        "title": "string",        "description": "string",        "schema": {}      }    },    "dev": true,    "title": "string",    "description": "string",    "iconUrl": "string",    "readmeUrl": "string",    "public": true,    "visibility": "public",    "verificationStatus": "unapproved",    "lifecycleStatus": "published",    "secrets": [      "string"    ],    "attributes": {      "property1": "string",      "property2": "string"    }  }}

{  "integration": {    "id": "stringstringstringstringstri",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "identifier": {      "fallbackHandlerScript": "string",      "extractScript": "string"    },    "sandbox": {      "identifierExtractScript": "string",      "messageExtractScript": "string"    },    "maxExecutionTime": 0,    "url": "string",    "signingSecret": "string",    "name": "string",    "version": "string",    "interfaces": {      "property1": {        "id": "stringstringstringstringstri",        "name": "string",        "version": "string",        "entities": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        },        "actions": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        },        "events": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        },        "channels": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        }      },      "property2": {        "id": "stringstringstringstringstri",        "name": "string",        "version": "string",        "entities": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        },        "actions": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        },        "events": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        },        "channels": {          "property1": {            "name": "string"          },          "property2": {            "name": "string"          }        }      }    },    "configuration": {      "title": "string",      "description": "string",      "identifier": {        "linkTemplateScript": "string",        "required": true      },      "schema": {}    },    "configurations": {      "property1": {        "title": "string",        "description": "string",        "identifier": {          "linkTemplateScript": "string",          "required": true        },        "schema": {}      },      "property2": {        "title": "string",        "description": "string",        "identifier": {          "linkTemplateScript": "string",          "required": true        },        "schema": {}      }    },    "channels": {      "property1": {        "title": "string",        "description": "string",        "messages": {          "property1": {            "schema": {}          },          "property2": {            "schema": {}          }        },        "conversation": {          "tags": {            "property1": {              "title": "string",              "description": "string"            },            "property2": {              "title": "string",              "description": "string"            }          },          "creation": {            "enabled": true,            "requiredTags": [              "string"            ]          }        },        "message": {          "tags": {            "property1": {              "title": "string",              "description": "string"            },            "property2": {              "title": "string",              "description": "string"            }          }        }      },      "property2": {        "title": "string",        "description": "string",        "messages": {          "property1": {            "schema": {}          },          "property2": {            "schema": {}          }        },        "conversation": {          "tags": {            "property1": {              "title": "string",              "description": "string"            },            "property2": {              "title": "string",              "description": "string"            }          },          "creation": {            "enabled": true,            "requiredTags": [              "string"            ]          }        },        "message": {          "tags": {            "property1": {              "title": "string",              "description": "string"            },            "property2": {              "title": "string",              "description": "string"            }          }        }      }    },    "states": {      "property1": {        "type": "conversation",        "schema": {}      },      "property2": {        "type": "conversation",        "schema": {}      }    },    "events": {      "property1": {        "title": "string",        "description": "string",        "schema": {},        "attributes": {          "property1": "string",          "property2": "string"        }      },      "property2": {        "title": "string",        "description": "string",        "schema": {},        "attributes": {          "property1": "string",          "property2": "string"        }      }    },    "actions": {      "property1": {        "title": "string",        "description": "string",        "billable": true,        "cacheable": true,        "input": {          "schema": {}        },        "output": {          "schema": {}        },        "attributes": {          "property1": "string",          "property2": "string"        }      },      "property2": {        "title": "string",        "description": "string",        "billable": true,        "cacheable": true,        "input": {          "schema": {}        },        "output": {          "schema": {}        },        "attributes": {          "property1": "string",          "property2": "string"        }      }    },    "user": {      "tags": {        "property1": {          "title": "string",          "description": "string"        },        "property2": {          "title": "string",          "description": "string"        }      },      "creation": {        "enabled": true,        "requiredTags": [          "string"        ]      }    },    "entities": {      "property1": {        "title": "string",        "description": "string",        "schema": {}      },      "property2": {        "title": "string",        "description": "string",        "schema": {}      }    },    "dev": true,    "title": "string",    "description": "string",    "iconUrl": "string",    "readmeUrl": "string",    "public": true,    "visibility": "public",    "verificationStatus": "unapproved",    "lifecycleStatus": "published",    "secrets": [      "string"    ],    "attributes": {      "property1": "string",      "property2": "string"    }  }}

Header Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`