ApiSchemas
Connection
One shape from the contract, as it appears on the wire.
Used by connections.create, connections.get, connections.getByName, connections.list, connections.upsert
JSON Schema
{
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/ConnectionId"
},
"name": {
"$ref": "#/components/schemas/ConnectionName"
},
"url": {
"type": "string",
"minLength": 1
},
"channel": {
"$ref": "#/components/schemas/ChannelId"
},
"transport": {
"$ref": "#/components/schemas/ConnectionTransport"
},
"auth": {
"$ref": "#/components/schemas/ConnectionAuth"
},
"hooksUrl": {
"type": "string",
"minLength": 1
},
"hookEvents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionEventType"
}
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"transport",
"auth",
"hookEvents",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}