Templates
Starter templates for creating integrations.
GET /api/integration-templates
List the available integration templates.
Authentication: Required
Response:
A collection under items. Each entry's value.integration is the payload skeleton to POST to /api/integrations; value.name, value.description, value.image, and value.createEditor are display/UI metadata, and value.needsConfiguration flags templates that require extra setup.
List integration templatesGET /api/integration-templates
Starter configurations for well-known providers. Each item’s value.integration is the payload skeleton to POST to /api/integrations.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/integration-templates"
}
},
"items": [
{
"detective": "00000000-0000-4000-8000-000000000001",
"id": "00000000-0000-4000-8000-000000000001:0",
"value": {
"group": "__top",
"name": "API Connection",
"image": "/images/icons/plug.svg",
"createEditor": "apiIntegrationEditor",
"description": "Set up a connection to an external service as a new Integration.",
"needsConfiguration": true,
"integration": {
"type": "api"
}
}
},
{
"detective": "00000000-0000-4000-8000-000000000002",
"id": "00000000-0000-4000-8000-000000000002:0",
"value": {
"group": "__top",
"name": "Google Drive™",
"image": "/images/icons/googledrive.svg",
"createEditor": {
"clientIdSecretForm": {
"clientId": null
}
},
"description": "Connect to your Google Drive account through an Integration. Once connected, you can use the \"Upload to Drive\" action in Jobs to send files to your Google Drive.",
"needsConfiguration": false,
"integration": {
"type": "googledrive",
"category": "Google Drive",
"name": "Google Drive™",
"imageUrl": "/images/icons/googledrive.svg",
"authUri": "https://accounts.google.com/o/oauth2/auth",
"revocationUri": "https://oauth2.googleapis.com/revoke",
"apiBaseUri": "https://www.googleapis.com",
"clientId": null,
"basicTokenAuth": false,
"scope": "https://www.googleapis.com/auth/drive.file",
"tokenUri": "https://oauth2.googleapis.com/token"
}
}
},
{
"detective": "00000000-0000-4000-8000-000000000003",
"id": "00000000-0000-4000-8000-000000000003:0",
"value": {
"group": "__top",
"name": "Microsoft OneDrive®",
"image": "/images/icons/office.svg",
"createEditor": {
"clientIdSecretForm": {
"clientId": null
}
},
"description": "Connect to your Microsoft OneDrive account through an Integration. Once connected, you can use the \"Upload to Drive\" action in Jobs to send files to your OneDrive.",
"needsConfiguration": false,
"integration": {
"type": "onedrive",
"category": "OneDrive",
"name": "Microsoft OneDrive®",
"imageUrl": "/images/icons/office.svg",
"authUri": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize",
"revocationUri": "https://login.microsoftonline.com/common/oauth2/v2.0/logout",
"apiBaseUri": "https://graph.microsoft.com/v1.0",
"clientId": null,
"basicTokenAuth": false,
"scope": "openid profile files.readwrite files.readwrite.all offline_access user.read Sites.Read.All Team.ReadBasic.All",
"tokenUri": "https://login.microsoftonline.com/common/oauth2/v2.0/token"
}
}
}
],
"start": 0,
"count": 3,
"total": 3
}
Custom integrations
A template is a starting point. You can always POST a fully custom integration with your own type, authType, and endpoints.