Dev portalChannel apis
The ChannelChannel APIs provide a centralized way to manage users, their contact information, and communication history across multiple channels. These APIs are essential for building a unified customer or user communication system. They allow you to
Overview
The following APIs help you manage contact data and active conversations for your teams and channels.
1. Get Channel
Get Channel by channel type (web, whatsapp, facebook, wechat, etc.).
-
Endpoint for Product:
GET https://app-gateway.imbrace.co/v1/backend/channels?type=web -
Endpoint for Demo:
GET https://app-gateway.demo.imbrace.co/v1/backend/channels?type=web -
Endpoint for Dev:
GET https://app-gateway.dev.imbrace.co/v1/backend/channels?type=web -
Headers:
Content-Type:application/jsonx-access-token:Your Access TokenYour Access Token
-
Body:
-
Result:
- Status code: 200 OK
{ "data": [ { "_id": "ch_a085c890-6932-4451-a0e2-291c28184355", "doc_name": "channel", "name": "WhatsApp 112", "active": false, "is_deleted": false, "bot_id": "u_imbrace_bot", "business_unit_id": "bu_imbrace_testing", "organization_id": "org_imbrace", "config": { "access_key": "afeafff12134123412", "phone_number": "123312224", "phone_number_id": "afe34234", "business_account_id": "afae34234r23", "namespace": null, "signing_key": null, "use_facebook_login": false, "_id": "65ddb97ec6825e4402c6275c", "type": "whatsapp" }, "public_id": "ch_a085c890-6932-4451-a0e2-291c28184355", "created_at": "2024-02-27T10:29:18.947Z", "credential_id": "1181", "updated_at": "2024-02-27T10:29:19.283Z", "workflow_id": "2345", "is_init": false, "touchpoints": [], "id": "ch_a085c890-6932-4451-a0e2-291c28184355" }, { "_id": "ch_e5c57300-c218-4b59-bcc3-74dd2c45e119", "doc_name": "channel", "name": "WhatsApp 10 test old", "active": false, "is_deleted": false, "bot_id": "u_imbrace_bot", "business_unit_id": "bu_imbrace_testing", "organization_id": "org_imbrace", "config": { "access_key": "111111111111111111111updated", "phone_number": "111111111111111updated", "phone_number_id": "111111111111111111updated", "business_account_id": "11111111111111111111updated", "namespace": null, "signing_key": null, "use_facebook_login": false, "_id": "65c31ac9085dd896c86ce848", "type": "whatsapp" }, "public_id": "ch_e5c57300-c218-4b59-bcc3-74dd2c45e119", "created_at": "2024-01-22T03:29:59.248Z", "credential_id": "1094", "updated_at": "2024-01-22T03:29:59.708Z", "workflow_id": "1880", "is_init": false, "touchpoints": [ { "_id": "tp_330e3ec4-34ea-4dc1-aec6-1e7a75ff9ea9", "doc_name": "touchpoints", "business_unit_id": "bu_imbrace_testing", "organization_id": "org_imbrace", "channel_id": "ch_e5c57300-c218-4b59-bcc3-74dd2c45e119", "default_channel_workflow_id": "1880", "scan_qrcode_count": 0, "from_url_count": 0, "url": "", "name": "My Touchpoint 249", "start_datetime": "2024-01-24T16:00:00.000Z", "end_datetime": null, "destination_url": "", "execute_workflow_id": "1880", "logo": "", "media_name": "", "description": "", "deleted_at": null, "is_archived": false, "is_paused": false, "public_id": "tp_330e3ec4-34ea-4dc1-aec6-1e7a75ff9ea9", "created_at": "2024-01-25T07:50:22.637Z" } ], "id": "ch_e5c57300-c218-4b59-bcc3-74dd2c45e119" } ] } -
Example:
curl --location 'https://app-gateway.dev.imbrace.co/v1/channels?type=whatsapp' \ --header 'X-Access-Token: acc_f7124766-e633-429c-b24a-ab0421a202e3'
2. Get count all channel
-
Endpoint for Product:
GET https://app-gateway.imbrace.co/v1/backend/channels/_count -
Endpoint for Demo:
GET https://app-gateway.demo.imbrace.co/v1/backend/channels/_count -
Endpoint for Dev:
GET https://app-gateway.dev.imbrace.co/v1/backend/channels/_count -
Headers:
Content-Type:application/jsonx-access-token:Your Access TokenYour Access Token
-
Body:
-
Result:
- Status code: 200 OK
{ "all": 143, "store": 2, "web": 110, "facebook": 7, "whatsapp": 8, "instagram": 7, "wechat": 1, "line": 8, "email": 0, "wecom": 0 } -
Example:
curl --location 'https://app-gateway.dev.imbrace.co/v1/backend/channels/_count' \ --header 'x-access-token: acc_f7124766-e633-429c-b24a-ab0421a202e3'
3. Get processed credential types
-
Endpoint for Product:
GET https://app-gateway.imbrace.co/v1/backend/workflow/processed-credential-types -
Endpoint for Demo:
GET https://app-gateway.demo.imbrace.co/v1/backend/workflow/processed-credential-types -
Endpoint for Dev:
GET https://app-gateway.dev.imbrace.co/v1/backend/workflow/processed-credential-types -
Headers:
Content-Type:application/jsonx-access-token:Your Access TokenYour Access Token
-
Body:
-
Result:
- Status code: 200 OK
{ "channel": [ { "name": "web", "displayName": "Web Widget", "documentationUrl": "web", "properties": [ { "displayName": "Credential Name", "name": "credentialName", "type": "string", "default": "", "description": "", "required": true } ] }, { "name": "email", "displayName": "Email", "documentationUrl": "email", "properties": [ { "displayName": "Credential Name", "name": "credentialName", "type": "string", "default": "", "description": "", "required": true } ] }, { "name": "facebook", "displayName": "Facebook", "documentationUrl": "facebook", "properties": [] }, { "name": "instagram", "displayName": "Instagram", "documentationUrl": "instagram", "properties": [] }, { "name": "whatsapp", "displayName": "WhatsApp", "documentationUrl": "whatsapp", "properties": [ { "displayName": "Credential Name", "name": "credentialName", "type": "string", "default": "", "description": "", "required": true }, { "displayName": "WhatsApp Phone Number*", "name": "phone_number", "type": "string", "default": "", "description": "Please include the country code without the “+”, ex. 85298765432", "required": true }, { "displayName": "Webhook URL", "name": "webhookUrl", "type": "string", "default": "https://dev-app-api.imbrace.co:5000/v1/facebook/whatsapp/webhook", "description": "In WhatsApp portal, paste the URL below to Webhook URL to generate the Token and Secret" }, { "displayName": "Verification Token", "name": "verificationToken", "type": "string", "default": "1!sdf12390kl1" }, { "displayName": "WhatsApp Phone Number ID*", "name": "phone_number_id", "type": "string", "default": "", "description": "", "required": true }, { "displayName": "WhatsApp Business Number*", "name": "business_account_id", "type": "string", "default": "", "description": "", "required": true }, { "displayName": "Access Token*", "name": "access_key", "type": "string", "default": "", "description": "", "required": true } ] }, { "name": "wechat", "displayName": "WeChat", "documentationUrl": "wechat", "properties": [ { "displayName": "Credential Name", "name": "credentialName", "type": "string", "default": "", "description": "", "required": true }, { "displayName": "Webhook URL", "name": "webhookUrl", "type": "string", "default": "https://dev-webhook.imbrace.co/v1/wechat/webhook", "description": "In WeChat portal, paste the URL below to Webhook URL to generate the Token and Secret" }, { "displayName": "App ID*", "name": "app_id", "type": "string", "default": "", "description": "", "required": true }, { "displayName": "Token*", "name": "token", "type": "string", "default": "", "description": "", "required": true }, { "displayName": "Secret*", "name": "secret", "type": "string", "default": "", "description": "", "required": true }, { "displayName": "EncodingAESKey*", "name": "encoding_aes_key", "type": "string", "default": "", "description": "", "required": true }, { "displayName": "Original ID*", "name": "user_name", "type": "string", "default": "", "description": "", "required": true } ] }, { "name": "line", "displayName": "LINE", "documentationUrl": "line", "properties": [ { "displayName": "Credential Name", "name": "credentialName", "type": "string", "default": "", "description": "", "required": true }, { "displayName": "Webhook URL", "name": "webhookUrl", "type": "string", "default": "https://dev-app-api.imbrace.co:5000/v1/line/webhook", "description": "In LINE portal, paste the URL below to Webhook URL to generate the Channel ID and Channel Secret" }, { "displayName": "LINE Channel ID*", "name": "line_channel_id", "type": "string", "default": "", "description": "", "required": true }, { "displayName": "LINE Channel Secret*", "name": "line_channel_secret", "type": "string", "default": "", "description": "", "required": true }, { "displayName": "LINE Channel Token*", "name": "line_channel_token", "type": "string", "default": "", "description": "", "required": true } ] } ], "integration": [ { "name": "airtableApi", "displayName": "Airtable API", "documentationUrl": "airtable", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/airtableApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "" } ] }, { "name": "apiTemplateIoApi", "displayName": "APITemplate.io API", "documentationUrl": "apiTemplateIo", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "" } ], "icon": "https://org-default.dev.imbrace.co/rest/node-icon/n8n-nodes-base.apiTemplateIo" }, { "name": "asanaApi", "displayName": "Asana API", "documentationUrl": "asana", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/asanaApi", "properties": [ { "displayName": "Access Token", "name": "accessToken", "type": "string", "default": "" } ], "authenticate": { "type": "generic", "properties": { "headers": { "Authorization": "=Bearer {{$credentials.accessToken}}" } } } }, { "name": "asanaOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "Asana OAuth2 API", "documentationUrl": "asana", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/asanaOAuth2Api", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://app.asana.com/-/oauth_authorize", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://app.asana.com/-/oauth_token", "required": true }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" } ] }, { "name": "aws", "displayName": "AWS", "documentationUrl": "aws", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/aws", "properties": [ { "displayName": "Region", "name": "region", "type": "string", "default": "us-east-1" }, { "displayName": "Access Key ID", "name": "accessKeyId", "type": "string", "default": "" }, { "displayName": "Secret Access Key", "name": "secretAccessKey", "type": "string", "default": "", "typeOptions": { "password": true } }, { "displayName": "Custom Endpoints", "name": "customEndpoints", "type": "boolean", "default": false }, { "displayName": "Rekognition Endpoint", "name": "rekognitionEndpoint", "type": "string", "displayOptions": { "show": { "customEndpoints": [ true ] } }, "default": "", "placeholder": "https://rekognition.{region}.amazonaws.com" }, { "displayName": "Lambda Endpoint", "name": "lambdaEndpoint", "type": "string", "displayOptions": { "show": { "customEndpoints": [ true ] } }, "default": "", "placeholder": "https://lambda.{region}.amazonaws.com" }, { "displayName": "SNS Endpoint", "name": "snsEndpoint", "type": "string", "displayOptions": { "show": { "customEndpoints": [ true ] } }, "default": "", "placeholder": "https://sns.{region}.amazonaws.com" }, { "displayName": "SES Endpoint", "name": "sesEndpoint", "type": "string", "displayOptions": { "show": { "customEndpoints": [ true ] } }, "default": "", "placeholder": "https://email.{region}.amazonaws.com" }, { "displayName": "SQS Endpoint", "name": "sqsEndpoint", "type": "string", "displayOptions": { "show": { "customEndpoints": [ true ] } }, "default": "", "placeholder": "https://sqs.{region}.amazonaws.com" }, { "displayName": "S3 Endpoint", "name": "s3Endpoint", "type": "string", "displayOptions": { "show": { "customEndpoints": [ true ] } }, "default": "", "placeholder": "https://s3.{region}.amazonaws.com" } ] }, { "name": "calendlyApi", "displayName": "Calendly API", "documentationUrl": "calendly", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/calendlyApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "" } ] }, { "name": "clickUpApi", "displayName": "ClickUp API", "documentationUrl": "clickUp", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/clickUpApi", "properties": [ { "displayName": "Access Token", "name": "accessToken", "type": "string", "default": "" } ] }, { "name": "clickUpOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "ClickUp OAuth2 API", "documentationUrl": "clickUp", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/clickUpOAuth2Api", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://app.clickup.com/api", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://api.clickup.com/api/v2/oauth/token", "required": true }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" } ] }, { "name": "facebookGraphApi", "displayName": "Facebook Graph API", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/facebookGraphApi", "documentationUrl": "facebookGraph", "properties": [ { "displayName": "Access Token", "name": "accessToken", "type": "string", "default": "" } ] }, { "name": "facebookGraphAppApi", "displayName": "Facebook Graph API (App)", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/facebookGraphAppApi", "documentationUrl": "facebookGraphApp", "extends": [ "facebookGraphApi" ], "properties": [ { "displayName": "App Secret", "name": "appSecret", "type": "string", "default": "", "description": "(Optional) When the app secret is set the node will verify this signature to validate the integrity and origin of the payload" } ] }, { "name": "freshdeskApi", "displayName": "Freshdesk API", "documentationUrl": "freshdesk", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/freshdeskApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "" }, { "displayName": "Domain", "name": "domain", "type": "string", "placeholder": "company", "description": "If the URL you get displayed on Freshdesk is \"https://company.freshdesk.com\" enter \"company\"", "default": "" } ] }, { "name": "freshserviceApi", "displayName": "Freshservice API", "documentationUrl": "freshservice", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/freshserviceApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "", "placeholder": "atuH3AbeH9HsKvgHuxg" }, { "displayName": "Domain", "name": "domain", "type": "string", "default": "", "description": "Domain in the Freshservice org URL." } ] }, { "name": "freshworksCrmApi", "displayName": "Freshworks CRM API", "documentationUrl": "freshdesk", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/freshworksCrmApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "", "placeholder": "BDsTn15vHezBlt_XGp3Tig" }, { "displayName": "Domain", "name": "domain", "type": "string", "default": "", "description": "Domain in the Freshworks CRM org URL." } ] }, { "name": "getResponseApi", "displayName": "GetResponse API", "documentationUrl": "getResponse", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/getResponseApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "" } ] }, { "name": "getResponseOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "GetResponse OAuth2 API", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/getResponseOAuth2Api", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://app.getresponse.com/oauth2_authorize.html", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://api.getresponse.com/v3/token", "required": true }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "header" } ] }, { "name": "gmailOAuth2", "extends": [ "googleOAuth2Api" ], "displayName": "Gmail OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/gmailOAuth2", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/gmail.labels https://www.googleapis.com/auth/gmail.addons.current.action.compose https://www.googleapis.com/auth/gmail.addons.current.message.action https://mail.google.com/ https://www.googleapis.com/auth/gmail.modify https://www.googleapis.com/auth/gmail.compose" } ] }, { "name": "googleAnalyticsOAuth2", "extends": [ "googleOAuth2Api" ], "displayName": "Google Analytics OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleAnalyticsOAuth2", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/analytics https://www.googleapis.com/auth/analytics.readonly" } ] }, { "name": "googleApi", "displayName": "Google API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleApi", "properties": [ { "displayName": "Service Account Email", "name": "email", "type": "string", "default": "", "description": "The Google Service account similar to user-808@project.iam.gserviceaccount.com", "required": true }, { "displayName": "Private Key", "name": "privateKey", "type": "string", "default": "", "placeholder": "-----BEGIN P K-----\nXIYEvQIBADANBg<...>0IhA7TMoGYPQc=\n-----END P K ----\n", "description": "Enter the private key located in the JSON file downloaded from Google Cloud Console", "required": true }, { "displayName": "Impersonate a User", "name": "inpersonate", "type": "boolean", "default": false }, { "displayName": "Email", "name": "delegatedEmail", "type": "string", "default": "", "displayOptions": { "show": { "inpersonate": [ true ] } }, "description": "The email address of the user for which the application is requesting delegated access" } ] }, { "name": "googleBigQueryOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google BigQuery OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleBigQueryOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/bigquery" } ] }, { "name": "googleBooksOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google Books OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleBooksOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/books" } ] }, { "name": "googleCalendarOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google Calendar OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleCalendarOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/calendar https://www.googleapis.com/auth/calendar.events" } ] }, { "name": "googleCloudNaturalLanguageOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google Cloud Natural Language OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleCloudNaturalLanguageOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/cloud-language https://www.googleapis.com/auth/cloud-platform" } ] }, { "name": "googleContactsOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google Contacts OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleContactsOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/contacts" } ] }, { "name": "googleDocsOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google Docs OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleDocsOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/documents https://www.googleapis.com/auth/drive https://www.googleapis.com/auth/drive.file" } ] }, { "name": "googleDriveOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google Drive OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleDriveOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/drive https://www.googleapis.com/auth/drive.appdata https://www.googleapis.com/auth/drive.photos.readonly" } ] }, { "name": "googleFirebaseCloudFirestoreOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google Firebase Cloud Firestore OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleFirebaseCloudFirestoreOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/firebase" } ] }, { "name": "googleFirebaseRealtimeDatabaseOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google Firebase Realtime Database OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleFirebaseRealtimeDatabaseOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/firebase.database https://www.googleapis.com/auth/firebase" }, { "displayName": "Region", "name": "region", "type": "options", "default": "firebaseio.com", "options": [ { "name": "us-central1", "value": "firebaseio.com" }, { "name": "europe-west1", "value": "europe-west1.firebasedatabase.app" }, { "name": "asia-southeast1", "value": "asia-southeast1.firebasedatabase.app" } ] } ] }, { "name": "googleOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "Google OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleOAuth2Api", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://accounts.google.com/o/oauth2/v2/auth" }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://oauth2.googleapis.com/token" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "access_type=offline&prompt=consent" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" } ] }, { "name": "googlePerspectiveOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google Perspective OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googlePerspectiveOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/userinfo.email" } ] }, { "name": "googleSheetsOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google Sheets OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleSheetsOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/drive.file https://www.googleapis.com/auth/spreadsheets" } ] }, { "name": "googleSheetsTriggerOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google Sheets Trigger OAuth2 API", "documentationUrl": "google/oauth-single-service", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleSheetsTriggerOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/drive https://www.googleapis.com/auth/drive.file https://www.googleapis.com/auth/spreadsheets https://www.googleapis.com/auth/drive.metadata" } ] }, { "name": "googleSlidesOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google Slides OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleSlidesOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/drive.file https://www.googleapis.com/auth/presentations" } ] }, { "name": "googleTasksOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google Tasks OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleTasksOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/tasks" } ] }, { "name": "googleTranslateOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "Google Translate OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleTranslateOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/cloud-translation" } ] }, { "name": "googleVertexAIApi", "displayName": "Google Vertex AI API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/googleVertexAIApi", "properties": [ { "displayName": "Service Account Email", "name": "email", "type": "string", "default": "", "description": "The Google Service account similar to user-808@project.iam.gserviceaccount.com", "required": true }, { "displayName": "Service Region", "name": "region", "type": "string", "default": "us-central1", "description": "The Google supported region similar to us-central1", "required": true }, { "displayName": "Service Endpoint ID", "name": "endpointId", "type": "string", "default": "", "description": "The Google service endpoint ID, which is for the google cloud service (e.g. Vertex AI). You can check this by visit https://console.cloud.google.com/vertex-ai/endpoints", "required": true }, { "displayName": "Service Account Cliend ID", "name": "clientId", "type": "string", "default": "", "description": "The Google Service account client ID in the json that downloaded when you create the key for the service account, you can check by visit the link https://console.cloud.google.com/iam-admin/serviceaccounts?project=YOUR_PROJECT_NAME", "required": true }, { "displayName": "Project ID", "name": "projectId", "type": "string", "default": "", "description": "The project ID similar to master-bulwark-366906", "required": true }, { "displayName": "Private Key ID", "name": "privateKeyId", "type": "string", "default": "", "description": "The project ID similar to 69860ac8cc86a6a0ad4a70c6fbdb9e71002cd65b", "required": true }, { "displayName": "Private Key", "name": "privateKey", "type": "string", "default": "", "placeholder": "-----BEGIN P K-----\nXIYEvQIBADANBg<...>0IhA7TMoGYPQc=\n-----END P K ----\n", "description": "Enter the private key located in the JSON file downloaded from Google Cloud Console", "required": true }, { "displayName": "Auth URI", "name": "authUri", "type": "string", "default": "https://accounts.google.com/o/oauth2/auth", "placeholder": "https://accounts.google.com/o/oauth2/auth", "description": "https://accounts.google.com/o/oauth2/auth", "required": false }, { "displayName": "Token URI", "name": "tokenUri", "type": "string", "default": "https://oauth2.googleapis.com/token", "placeholder": "https://oauth2.googleapis.com/token", "description": "https://oauth2.googleapis.com/token", "required": false }, { "displayName": "Auth provider x509 cert URI", "name": "authProviderX509CertUrl", "type": "string", "default": "https://www.googleapis.com/oauth2/v1/certs", "placeholder": "https://www.googleapis.com/oauth2/v1/certs", "description": "https://www.googleapis.com/oauth2/v1/certs", "required": false }, { "displayName": "Client x509 Cert URL", "name": "clientX509CertUrl", "type": "string", "default": "", "description": "The Google Service account similar to https://www.googleapis.com/robot/v1/metadata/x509/user-808@project.iam.gserviceaccount.com", "required": false }, { "displayName": "Impersonate a User", "name": "inpersonate", "type": "boolean", "default": false }, { "displayName": "Email", "name": "delegatedEmail", "type": "string", "default": "", "displayOptions": { "show": { "inpersonate": [ true ] } }, "description": "The email address of the user for which the application is requesting delegated access" } ] }, { "name": "gSuiteAdminOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "G Suite Admin OAuth2 API", "documentationUrl": "google", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/gSuiteAdminOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/admin.directory.group https://www.googleapis.com/auth/admin.directory.user https://www.googleapis.com/auth/admin.directory.domain.readonly https://www.googleapis.com/auth/admin.directory.userschema.readonly" } ] }, { "name": "homeAssistantApi", "displayName": "Home Assistant API", "documentationUrl": "homeAssistant", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/homeAssistantApi", "properties": [ { "displayName": "Host", "name": "host", "type": "string", "default": "" }, { "displayName": "Port", "name": "port", "type": "number", "default": 8123 }, { "displayName": "SSL", "name": "ssl", "type": "boolean", "default": false }, { "displayName": "Access Token", "name": "accessToken", "type": "string", "default": "" } ] }, { "name": "httpBasicAuth", "displayName": "Basic Auth", "documentationUrl": "httpRequest", "genericAuth": true, "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/httpBasicAuth", "properties": [ { "displayName": "User", "name": "user", "type": "string", "default": "" }, { "displayName": "Password", "name": "password", "type": "string", "typeOptions": { "password": true }, "default": "" } ] }, { "name": "httpDigestAuth", "displayName": "Digest Auth", "documentationUrl": "httpRequest", "genericAuth": true, "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/httpDigestAuth", "properties": [ { "displayName": "User", "name": "user", "type": "string", "default": "" }, { "displayName": "Password", "name": "password", "type": "string", "typeOptions": { "password": true }, "default": "" } ] }, { "name": "httpHeaderAuth", "displayName": "Header Auth", "documentationUrl": "httpRequest", "genericAuth": true, "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/httpHeaderAuth", "properties": [ { "displayName": "Name", "name": "name", "type": "string", "default": "" }, { "displayName": "Value", "name": "value", "type": "string", "default": "" } ], "authenticate": { "type": "generic", "properties": { "headers": { "={{$credentials.name}}": "={{$credentials.value}}" } } } }, { "name": "httpQueryAuth", "displayName": "Query Auth", "documentationUrl": "httpRequest", "genericAuth": true, "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/httpQueryAuth", "properties": [ { "displayName": "Name", "name": "name", "type": "string", "default": "" }, { "displayName": "Value", "name": "value", "type": "string", "default": "" } ] }, { "name": "hubspotApi", "displayName": "HubSpot API", "documentationUrl": "hubspot", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/hubspotApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "" } ] }, { "name": "hubspotAppToken", "displayName": "HubSpot App Token", "documentationUrl": "hubspot", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/hubspotAppToken", "properties": [ { "displayName": "APP Token", "name": "appToken", "type": "string", "default": "" } ] }, { "name": "hubspotDeveloperApi", "displayName": "Hubspot Developer API", "documentationUrl": "hubspot", "extends": [ "oAuth2Api" ], "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/hubspotDeveloperApi", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://app.hubspot.com/oauth/authorize", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://api.hubapi.com/oauth/v1/token", "required": true }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "grant_type=authorization_code" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" }, { "displayName": "Developer API Key", "name": "apiKey", "type": "string", "default": "" }, { "displayName": "APP ID", "name": "appId", "type": "string", "required": true, "default": "", "description": "The APP ID" }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "crm.objects.contacts.read crm.schemas.contacts.read crm.objects.companies.read crm.schemas.companies.read crm.objects.deals.read crm.schemas.deals.read" } ] }, { "name": "hubspotOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "HubSpot OAuth2 API", "documentationUrl": "hubspot", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/hubspotOAuth2Api", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://app.hubspot.com/oauth/authorize", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://api.hubapi.com/oauth/v1/token", "required": true }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "crm.schemas.deals.read crm.objects.owners.read crm.objects.contacts.write crm.objects.companies.write crm.objects.companies.read crm.objects.deals.read crm.schemas.contacts.read crm.objects.deals.write crm.objects.contacts.read crm.schemas.companies.read forms tickets" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "grant_type=authorization_code" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" } ] }, { "name": "imap", "displayName": "IMAP", "documentationUrl": "imap", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/imap", "properties": [ { "displayName": "User", "name": "user", "type": "string", "default": "" }, { "displayName": "Password", "name": "password", "type": "string", "typeOptions": { "password": true }, "default": "" }, { "displayName": "Host", "name": "host", "type": "string", "default": "" }, { "displayName": "Port", "name": "port", "type": "number", "default": 993 }, { "displayName": "SSL/TLS", "name": "secure", "type": "boolean", "default": true }, { "displayName": "Allow Self-Signed Certificates", "name": "allowUnauthorizedCerts", "type": "boolean", "description": "Whether to connect even if SSL certificate validation is not possible", "default": false } ] }, { "name": "iterableApi", "displayName": "Iterable API", "documentationUrl": "iterable", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/iterableApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "" } ] }, { "name": "jotFormApi", "displayName": "JotForm API", "documentationUrl": "jotForm", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/jotFormApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "" }, { "displayName": "API Domain", "name": "apiDomain", "type": "options", "options": [ { "name": "api.jotform.com", "value": "api.jotform.com" }, { "name": "eu-api.jotform.com", "value": "eu-api.jotform.com" } ], "default": "api.jotform.com", "description": "The API domain to use. Use \"eu-api.jotform.com\" if your account is in based in Europe." } ] }, { "name": "kafka", "displayName": "Kafka", "documentationUrl": "kafka", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/kafka", "properties": [ { "displayName": "Client ID", "name": "clientId", "type": "string", "default": "", "placeholder": "my-app" }, { "displayName": "Brokers", "name": "brokers", "type": "string", "default": "", "placeholder": "kafka1:9092,kafka2:9092" }, { "displayName": "SSL", "name": "ssl", "type": "boolean", "default": true }, { "displayName": "Authentication", "name": "authentication", "type": "boolean", "default": false }, { "displayName": "Username", "name": "username", "type": "string", "displayOptions": { "show": { "authentication": [ true ] } }, "default": "", "description": "Optional username if authenticated is required" }, { "displayName": "Password", "name": "password", "type": "string", "displayOptions": { "show": { "authentication": [ true ] } }, "typeOptions": { "password": true }, "default": "", "description": "Optional password if authenticated is required" }, { "displayName": "SASL Mechanism", "name": "saslMechanism", "type": "options", "displayOptions": { "show": { "authentication": [ true ] } }, "options": [ { "name": "Plain", "value": "plain" }, { "name": "scram-sha-256", "value": "scram-sha-256" }, { "name": "scram-sha-512", "value": "scram-sha-512" } ], "default": "plain", "description": "The SASL mechanism" }, { "displayName": "AWS Region", "name": "awsRegion", "type": "string", "displayOptions": { "show": { "authMethod": [ "iam" ] } }, "default": "", "placeholder": "ap-east-1", "description": "AWS region for MSK cluster" }, { "displayName": "AWS Access Key ID", "name": "awsAccessKeyId", "type": "string", "displayOptions": { "show": { "authMethod": [ "iam" ] } }, "default": "", "description": "AWS Access Key ID (leave empty to use IAM role)" }, { "displayName": "AWS Secret Access Key", "name": "awsSecretAccessKey", "type": "string", "displayOptions": { "show": { "authMethod": [ "iam" ] } }, "typeOptions": { "password": true }, "default": "", "description": "AWS Secret Access Key (leave empty to use IAM role)" }, { "displayName": "AWS Session Token", "name": "awsSessionToken", "type": "string", "displayOptions": { "show": { "authMethod": [ "iam" ] } }, "default": "", "description": "AWS Session Token (for temporary credentials)" }, { "displayName": "Authentication Method", "name": "authMethod", "type": "options", "options": [ { "name": "SASL/SSL", "value": "sasl" }, { "name": "MSK IAM", "value": "iam" } ], "default": "sasl", "description": "Choose authentication method" } ] }, { "name": "linkedInCommunityManagementOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "LinkedIn Community Management OAuth2 API", "documentationUrl": "linkedIn", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/linkedInCommunityManagementOAuth2Api", "properties": [ { "displayName": "Grant Type", "name": "grantType", "type": "hidden", "default": "authorizationCode" }, { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://www.linkedin.com/oauth/v2/authorization", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://www.linkedin.com/oauth/v2/accessToken", "required": true }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "w_member_social w_organization_social r_basicprofile" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" } ] }, { "name": "linkedInOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "LinkedIn OAuth2 API", "documentationUrl": "linkedIn", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/linkedInOAuth2Api", "properties": [ { "displayName": "Grant Type", "name": "grantType", "type": "hidden", "default": "authorizationCode" }, { "displayName": "Organization Support", "name": "organizationSupport", "type": "boolean", "default": true, "description": "Whether to request permissions to post as an organization" }, { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://www.linkedin.com/oauth/v2/authorization", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://www.linkedin.com/oauth/v2/accessToken", "required": true }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "=w_member_social{{$self[\"organizationSupport\"] === true ? \",w_organization_social\": $self[\"legacy\"] === true ? \",r_liteprofile,r_emailaddress\" : \",profile,email,openid\"}}", "description": "Standard scopes for posting on behalf of a user or organization. See <a href=\"https://docs.microsoft.com/en-us/linkedin/marketing/getting-started#available-permissions\"> this resource </a>." }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" }, { "displayName": "Legacy", "name": "legacy", "type": "boolean", "default": true, "description": "Whether to use the legacy API" } ] }, { "name": "magento2Api", "displayName": "Magento 2 API", "documentationUrl": "magento2", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/magento2Api", "properties": [ { "displayName": "Host", "name": "host", "type": "string", "default": "" }, { "displayName": "Access Token", "name": "accessToken", "type": "string", "default": "" } ], "test": { "request": { "baseURL": "={{$credentials.host}}", "url": "/rest/default/V1/modules" } }, "authenticate": { "type": "generic", "properties": { "headers": { "Authorization": "=Bearer {{$credentials.accessToken}}" } } } }, { "name": "mailchimpApi", "displayName": "Mailchimp API", "documentationUrl": "mailchimp", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/mailchimpApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "" } ] }, { "name": "mailchimpOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "Mailchimp OAuth2 API", "documentationUrl": "mailchimp", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/mailchimpOAuth2Api", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://login.mailchimp.com/oauth2/authorize", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://login.mailchimp.com/oauth2/token", "required": true }, { "displayName": "Metadata", "name": "metadataUrl", "type": "hidden", "default": "https://login.mailchimp.com/oauth2/metadata", "required": true }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" } ] }, { "name": "mailgunApi", "displayName": "Mailgun API", "documentationUrl": "mailgun", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/mailgunApi", "properties": [ { "displayName": "API Domain", "name": "apiDomain", "type": "options", "options": [ { "name": "api.eu.mailgun.net", "value": "api.eu.mailgun.net" }, { "name": "api.mailgun.net", "value": "api.mailgun.net" } ], "default": "api.mailgun.net", "description": "The configured mailgun API domain" }, { "displayName": "Email Domain", "name": "emailDomain", "type": "string", "default": "" }, { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "" } ] }, { "name": "messageBirdApi", "displayName": "MessageBird API", "documentationUrl": "messageBird", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/messageBirdApi", "properties": [ { "displayName": "API Key", "name": "accessKey", "type": "string", "default": "" } ] }, { "name": "microsoftDynamicsOAuth2Api", "extends": [ "microsoftOAuth2Api" ], "displayName": "Microsoft Dynamics OAuth2 API", "documentationUrl": "microsoft", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/microsoftDynamicsOAuth2Api", "properties": [ { "displayName": "Subdomain", "name": "subdomain", "type": "string", "required": true, "placeholder": "organization", "default": "" }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "=openid offline_access https://{{$self.subdomain}}.crm.dynamics.com/.default" } ] }, { "name": "microsoftExcelOAuth2Api", "extends": [ "microsoftOAuth2Api" ], "displayName": "Microsoft Excel OAuth2 API", "documentationUrl": "microsoft", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/microsoftExcelOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "openid offline_access Files.ReadWrite" } ] }, { "name": "microsoftGraphSecurityOAuth2Api", "displayName": "Microsoft Graph Security OAuth2 API", "extends": [ "microsoftOAuth2Api" ], "documentationUrl": "microsoft", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/microsoftGraphSecurityOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "SecurityEvents.ReadWrite.All" } ] }, { "name": "microsoftOAuth2Api", "extends": [ "oAuth2Api" ], "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/microsoftOAuth2Api", "displayName": "Microsoft OAuth2 API", "documentationUrl": "microsoft", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "string", "default": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize" }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "string", "default": "https://login.microsoftonline.com/common/oauth2/v2.0/token" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "response_mode=query" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" } ] }, { "name": "microsoftOneDriveOAuth2Api", "extends": [ "microsoftOAuth2Api" ], "displayName": "Microsoft OneDrive OAuth2 API", "documentationUrl": "microsoft", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/microsoftOneDriveOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "openid offline_access Files.ReadWrite.All" } ] }, { "name": "microsoftOutlookOAuth2Api", "extends": [ "microsoftOAuth2Api" ], "displayName": "Microsoft Outlook OAuth2 API", "documentationUrl": "microsoft", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/microsoftOutlookOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "openid offline_access Contacts.Read Contacts.ReadWrite Calendars.Read Calendars.Read.Shared Calendars.ReadWrite Mail.ReadWrite Mail.ReadWrite.Shared Mail.Send Mail.Send.Shared MailboxSettings.Read" }, { "displayName": "Use Shared Mailbox", "name": "useShared", "type": "boolean", "default": false }, { "displayName": "User Principal Name", "name": "userPrincipalName", "description": "Target user's UPN or ID", "type": "string", "default": "", "displayOptions": { "show": { "useShared": [ true ] } } } ] }, { "name": "microsoftSql", "displayName": "Microsoft SQL", "documentationUrl": "microsoftSql", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/microsoftSql", "properties": [ { "displayName": "Server", "name": "server", "type": "string", "default": "localhost" }, { "displayName": "Database", "name": "database", "type": "string", "default": "master" }, { "displayName": "User", "name": "user", "type": "string", "default": "sa" }, { "displayName": "Password", "name": "password", "type": "string", "typeOptions": { "password": true }, "default": "" }, { "displayName": "Port", "name": "port", "type": "number", "default": 1433 }, { "displayName": "Domain", "name": "domain", "type": "string", "default": "" }, { "displayName": "TLS", "name": "tls", "type": "boolean", "default": true }, { "displayName": "Connect Timeout", "name": "connectTimeout", "type": "number", "default": 15000, "description": "Connection timeout in ms" }, { "displayName": "Request Timeout", "name": "requestTimeout", "type": "number", "default": 15000, "description": "Request timeout in ms" } ] }, { "name": "microsoftTeamsOAuth2Api", "extends": [ "microsoftOAuth2Api" ], "displayName": "Microsoft Teams OAuth2 API", "documentationUrl": "microsoft", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/microsoftTeamsOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "openid offline_access User.ReadWrite.All Group.ReadWrite.All Chat.ReadWrite" } ] }, { "name": "microsoftToDoOAuth2Api", "extends": [ "microsoftOAuth2Api" ], "displayName": "Microsoft To Do OAuth2 API", "documentationUrl": "microsoft", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/microsoftToDoOAuth2Api", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "openid offline_access Tasks.ReadWrite" } ] }, { "name": "mindeeInvoiceApi", "displayName": "Mindee Invoice API", "documentationUrl": "mindee", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/mindeeInvoiceApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "" } ] }, { "name": "mindeeReceiptApi", "displayName": "Mindee Receipt API", "documentationUrl": "mindee", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/mindeeReceiptApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "" } ] }, { "name": "mondayComApi", "displayName": "Monday.com API", "documentationUrl": "mondayCom", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/mondayComApi", "properties": [ { "displayName": "Token V2", "name": "apiToken", "type": "string", "typeOptions": { "password": true }, "default": "" } ], "authenticate": { "type": "generic", "properties": { "headers": { "Authorization": "=Bearer {{$credentials.apiToken}}" } } }, "test": { "request": { "headers": { "API-Version": "2023-10", "Content-Type": "application/json" }, "baseURL": "https://api.monday.com/v2", "method": "POST", "body": "{\"query\":\"query { me { name }}\"}" } } }, { "name": "mondayComOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "Monday.com OAuth2 API", "documentationUrl": "mondaycom", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/mondayComOAuth2Api", "properties": [ { "displayName": "Grant Type", "name": "grantType", "type": "hidden", "default": "authorizationCode" }, { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://auth.monday.com/oauth2/authorize", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://auth.monday.com/oauth2/token", "required": true }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "boards:write boards:read" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" } ] }, { "name": "mongoDb", "displayName": "MongoDB", "documentationUrl": "mongoDb", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/mongoDb", "properties": [ { "displayName": "Configuration Type", "name": "configurationType", "type": "options", "options": [ { "name": "Connection String", "value": "connectionString", "description": "Provide connection data via string" }, { "name": "Values", "value": "values", "description": "Provide connection data via values" } ], "default": "values" }, { "displayName": "Connection String", "name": "connectionString", "type": "string", "displayOptions": { "show": { "configurationType": [ "connectionString" ] } }, "default": "", "description": "If provided, the value here will be used as a MongoDB connection string,\n\t\t\t\t\t\t and the MongoDB credentials will be ignored" }, { "displayName": "Host", "name": "host", "type": "string", "displayOptions": { "show": { "configurationType": [ "values" ] } }, "default": "localhost" }, { "displayName": "Database", "name": "database", "type": "string", "default": "", "description": "Note: the database should still be provided even if using an override connection string" }, { "displayName": "User", "name": "user", "type": "string", "displayOptions": { "show": { "configurationType": [ "values" ] } }, "default": "" }, { "displayName": "Password", "name": "password", "type": "string", "typeOptions": { "password": true }, "displayOptions": { "show": { "configurationType": [ "values" ] } }, "default": "" }, { "displayName": "Port", "name": "port", "type": "number", "displayOptions": { "show": { "configurationType": [ "values" ] } }, "default": 27017 } ] }, { "name": "mqtt", "displayName": "MQTT", "documentationUrl": "mqtt", "properties": [ { "displayName": "Protocol", "name": "protocol", "type": "options", "options": [ { "name": "Mqtt", "value": "mqtt" }, { "name": "Mqtts", "value": "mqtts" }, { "name": "Ws", "value": "ws" } ], "default": "mqtt" }, { "displayName": "Host", "name": "host", "type": "string", "default": "" }, { "displayName": "Port", "name": "port", "type": "number", "default": 1883 }, { "displayName": "Username", "name": "username", "type": "string", "default": "" }, { "displayName": "Password", "name": "password", "type": "string", "typeOptions": { "password": true }, "default": "" }, { "displayName": "Clean Session", "name": "clean", "type": "boolean", "default": true, "description": "Whether to use clean session - set to false to receive QoS 1 and 2 messages while offline" }, { "displayName": "Client ID", "name": "clientId", "type": "string", "default": "", "description": "Client ID. If left empty, one is autogenerated for you." }, { "displayName": "SSL", "name": "ssl", "type": "boolean", "default": false }, { "displayName": "Passwordless", "name": "passwordless", "type": "boolean", "displayOptions": { "show": { "ssl": [ true ] } }, "default": true, "description": "Whether to use passwordless connection with certificates (SASL mechanism EXTERNAL)" }, { "displayName": "CA Certificates", "name": "ca", "type": "string", "typeOptions": { "password": true }, "displayOptions": { "show": { "ssl": [ true ] } }, "default": "", "description": "SSL CA Certificates to use" }, { "displayName": "Reject Unauthorized Certificate", "name": "rejectUnauthorized", "type": "boolean", "displayOptions": { "show": { "ssl": [ true ], "passwordless": [ true ] } }, "default": false, "description": "Whether to validate Certificate" }, { "displayName": "Client Certificate", "name": "cert", "type": "string", "typeOptions": { "password": true }, "displayOptions": { "show": { "ssl": [ true ], "passwordless": [ true ] } }, "default": "", "description": "SSL Client Certificate to use" }, { "displayName": "Client Key", "name": "key", "type": "string", "typeOptions": { "password": true }, "displayOptions": { "show": { "ssl": [ true ], "passwordless": [ true ] } }, "default": "", "description": "SSL Client Key to use" } ], "icon": "https://org-default.dev.imbrace.co/rest/node-icon/n8n-nodes-base.mqtt" }, { "name": "mySql", "displayName": "MySQL", "documentationUrl": "mySql", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/mySql", "properties": [ { "displayName": "Host", "name": "host", "type": "string", "default": "localhost" }, { "displayName": "Database", "name": "database", "type": "string", "default": "mysql" }, { "displayName": "User", "name": "user", "type": "string", "default": "mysql" }, { "displayName": "Password", "name": "password", "type": "string", "typeOptions": { "password": true }, "default": "" }, { "displayName": "Port", "name": "port", "type": "number", "default": 3306 }, { "displayName": "Connect Timeout", "name": "connectTimeout", "type": "number", "default": 10000, "description": "The milliseconds before a timeout occurs during the initial connection to the MySQL server" }, { "displayName": "SSL", "name": "ssl", "type": "boolean", "default": false }, { "displayName": "CA Certificate", "name": "caCertificate", "typeOptions": { "alwaysOpenEditWindow": true, "password": true }, "displayOptions": { "show": { "ssl": [ true ] } }, "type": "string", "default": "" }, { "displayName": "Client Private Key", "name": "clientPrivateKey", "typeOptions": { "alwaysOpenEditWindow": true, "password": true }, "displayOptions": { "show": { "ssl": [ true ] } }, "type": "string", "default": "" }, { "displayName": "Client Certificate", "name": "clientCertificate", "typeOptions": { "alwaysOpenEditWindow": true, "password": true }, "displayOptions": { "show": { "ssl": [ true ] } }, "type": "string", "default": "" } ] }, { "name": "netsuite", "displayName": "NetSuite", "documentationUrl": "netsuite", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/netsuite", "properties": [ { "displayName": "Hostname", "name": "hostname", "type": "string", "default": "", "required": true }, { "displayName": "Account ID", "name": "accountId", "type": "string", "default": "", "required": true, "description": "NetSuite Account ID" }, { "displayName": "Consumer Key", "name": "consumerKey", "type": "string", "default": "", "required": true }, { "displayName": "Consumer Secret", "name": "consumerSecret", "type": "string", "typeOptions": { "password": true }, "default": "", "required": true }, { "displayName": "Token Key", "name": "tokenKey", "type": "string", "default": "", "required": true }, { "displayName": "Token Secret", "name": "tokenSecret", "type": "string", "typeOptions": { "password": true }, "default": "", "required": true } ] }, { "name": "nocoDb", "displayName": "NocoDB", "documentationUrl": "nocoDb", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/nocoDb", "properties": [ { "displayName": "API Token", "name": "apiToken", "type": "string", "default": "" }, { "displayName": "Host", "name": "host", "type": "string", "default": "", "placeholder": "http(s)://localhost:8080" } ] }, { "name": "oAuth1Api", "displayName": "OAuth1 API", "documentationUrl": "httpRequest", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/oAuth1Api", "genericAuth": true, "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "string", "default": "", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "string", "default": "", "required": true }, { "displayName": "Consumer Key", "name": "consumerKey", "type": "string", "default": "", "required": true }, { "displayName": "Consumer Secret", "name": "consumerSecret", "type": "string", "default": "", "required": true }, { "displayName": "Request Token URL", "name": "requestTokenUrl", "type": "string", "default": "", "required": true }, { "displayName": "Signature Method", "name": "signatureMethod", "type": "options", "options": [ { "name": "HMAC-SHA1", "value": "HMAC-SHA1" }, { "name": "HMAC-SHA256", "value": "HMAC-SHA256" }, { "name": "HMAC-SHA512", "value": "HMAC-SHA512" } ], "default": "HMAC-SHA1", "required": true } ] }, { "name": "oAuth2Api", "displayName": "OAuth2 API", "documentationUrl": "httpRequest", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/oAuth2Api", "genericAuth": true, "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "string", "default": "", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "string", "default": "", "required": true }, { "displayName": "Client ID", "name": "clientId", "type": "string", "default": "", "required": true }, { "displayName": "Client Secret", "name": "clientSecret", "type": "string", "typeOptions": { "password": true }, "default": "", "required": true }, { "displayName": "Scope", "name": "scope", "type": "string", "default": "" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "string", "default": "", "description": "For some services additional query parameters have to be set which can be defined here", "placeholder": "access_type=offline" }, { "displayName": "Authentication", "name": "authentication", "type": "options", "options": [ { "name": "Body", "value": "body", "description": "Send credentials in body" }, { "name": "Header", "value": "header", "description": "Send credentials as Basic Auth header" } ], "default": "header" } ] }, { "name": "odooApi", "displayName": "Odoo API", "documentationUrl": "odoo", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/odooApi", "properties": [ { "displayName": "Site URL", "name": "url", "type": "string", "default": "", "placeholder": "https://my-organization.odoo.com", "required": true }, { "displayName": "Username", "name": "username", "type": "string", "default": "", "placeholder": "user@email.com", "required": true }, { "displayName": "Password or API Key", "name": "password", "type": "string", "default": "", "typeOptions": { "password": true }, "required": true }, { "displayName": "Database Name", "name": "db", "type": "string", "default": "" } ] }, { "name": "openai", "displayName": "Open AI API", "documentationUrl": "openai", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/openai", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "typeOptions": { "password": true }, "default": "" } ] }, { "name": "payPalApi", "displayName": "PayPal API", "documentationUrl": "payPal", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/payPalApi", "properties": [ { "displayName": "Client ID", "name": "clientId", "type": "string", "default": "" }, { "displayName": "Secret", "name": "secret", "type": "string", "default": "" }, { "displayName": "Environment", "name": "env", "type": "options", "default": "live", "options": [ { "name": "Sandbox", "value": "sanbox" }, { "name": "Live", "value": "live" } ] } ] }, { "name": "postgres", "displayName": "PostgreSQL", "documentationUrl": "postgres", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/postgres", "properties": [ { "displayName": "Host", "name": "host", "type": "string", "default": "localhost" }, { "displayName": "Database", "name": "database", "type": "string", "default": "postgres" }, { "displayName": "User", "name": "user", "type": "string", "default": "postgres" }, { "displayName": "Password", "name": "password", "type": "string", "typeOptions": { "password": true }, "default": "" }, { "displayName": "Ignore SSL Issues", "name": "allowUnauthorizedCerts", "type": "boolean", "default": false, "description": "Whether to connect even if SSL certificate validation is not possible" }, { "displayName": "SSL", "name": "ssl", "type": "options", "displayOptions": { "show": { "allowUnauthorizedCerts": [ false ] } }, "options": [ { "name": "Allow", "value": "allow" }, { "name": "Disable", "value": "disable" }, { "name": "Require", "value": "require" }, { "name": "Verify (Not Implemented)", "value": "verify" }, { "name": "Verify-Full (Not Implemented)", "value": "verify-full" } ], "default": "disable" }, { "displayName": "Port", "name": "port", "type": "number", "default": 5432 } ] }, { "name": "philipsHueOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "PhilipHue OAuth2 API", "documentationUrl": "philipsHue", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/philipsHueOAuth2Api", "properties": [ { "displayName": "APP ID", "name": "appId", "type": "string", "default": "" }, { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://api.meethue.com/v2/oauth2/authorize" }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://api.meethue.com/v2/oauth2/token" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "={{\"appid=\"+$self[\"appId\"]}}" }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "header" } ] }, { "name": "quickBooksOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "QuickBooks Online OAuth2 API", "documentationUrl": "quickbooks", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/quickBooksOAuth2Api", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://appcenter.intuit.com/connect/oauth2" }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer" }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "com.intuit.quickbooks.accounting" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "header" }, { "displayName": "Environment", "name": "environment", "type": "options", "default": "production", "options": [ { "name": "Production", "value": "production" }, { "name": "Sandbox", "value": "sandbox" } ] } ] }, { "name": "redis", "displayName": "Redis", "documentationUrl": "redis", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/redis", "properties": [ { "displayName": "Password", "name": "password", "type": "string", "typeOptions": { "password": true }, "default": "" }, { "displayName": "Host", "name": "host", "type": "string", "default": "localhost" }, { "displayName": "Port", "name": "port", "type": "number", "default": 6379 }, { "displayName": "Database Number", "name": "database", "type": "number", "default": 0 } ] }, { "name": "s3", "displayName": "S3", "documentationUrl": "s3", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/s3", "properties": [ { "displayName": "S3 Endpoint", "name": "endpoint", "type": "string", "default": "" }, { "displayName": "Region", "name": "region", "type": "string", "default": "us-east-1" }, { "displayName": "Access Key ID", "name": "accessKeyId", "type": "string", "default": "" }, { "displayName": "Secret Access Key", "name": "secretAccessKey", "type": "string", "default": "", "typeOptions": { "password": true } }, { "displayName": "Force Path Style", "name": "forcePathStyle", "type": "boolean", "default": false } ] }, { "name": "salesforceJwtApi", "displayName": "Salesforce JWT API", "documentationUrl": "salesforce", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/salesforceJwtApi", "properties": [ { "displayName": "Environment Type", "name": "environment", "type": "options", "options": [ { "name": "Production", "value": "production" }, { "name": "Sandbox", "value": "sandbox" } ], "default": "production" }, { "displayName": "Client ID", "name": "clientId", "type": "string", "default": "", "required": true, "description": "Consumer Key from Salesforce Connected App" }, { "displayName": "Username", "name": "username", "type": "string", "default": "", "required": true }, { "displayName": "Private Key", "name": "privateKey", "type": "string", "typeOptions": { "password": true }, "default": "", "required": true, "description": "Use the multiline editor. Make sure it is in standard PEM format:<br />-----BEGIN -----<br />KEY DATA GOES HERE<br />-----END -----" } ] }, { "name": "salesforceOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "Salesforce OAuth2 API", "documentationUrl": "salesforce", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/salesforceOAuth2Api", "properties": [ { "displayName": "Environment Type", "name": "environment", "type": "options", "options": [ { "name": "Production", "value": "production" }, { "name": "Sandbox", "value": "sandbox" } ], "default": "production" }, { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "required": true, "default": "={{ $self[\"environment\"] === \"sandbox\" ? \"https://test.salesforce.com/services/oauth2/authorize\" : \"https://login.salesforce.com/services/oauth2/authorize\" }}" }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "required": true, "default": "={{ $self[\"environment\"] === \"sandbox\" ? \"https://test.salesforce.com/services/oauth2/token\" : \"https://login.salesforce.com/services/oauth2/token\" }}" }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "full refresh_token" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "header" } ] }, { "name": "salesmateApi", "displayName": "Salesmate API", "documentationUrl": "salesmate", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/salesmateApi", "properties": [ { "displayName": "Session Token", "name": "sessionToken", "type": "string", "default": "" }, { "displayName": "URL", "name": "url", "type": "string", "default": "" } ] }, { "name": "serviceNowOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "ServiceNow OAuth2 API", "documentationUrl": "serviceNow", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/serviceNowOAuth2Api", "properties": [ { "displayName": "Subdomain", "name": "subdomain", "type": "string", "default": "", "hint": "The subdomain can be extracted from the URL. If the URL is: https://dev99890.service-now.com the subdomain is dev99890", "required": true }, { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "=https://{{$self[\"subdomain\"]}}.service-now.com/oauth_auth.do", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "=https://{{$self[\"subdomain\"]}}.service-now.com/oauth_token.do", "required": true }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "useraccount" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "response_type=code" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "grant_type=authorization_code" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "header" } ] }, { "name": "serviceNowBasicApi", "extends": [ "httpBasicAuth" ], "displayName": "ServiceNow Basic Auth API", "documentationUrl": "serviceNow", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/serviceNowBasicApi", "properties": [ { "displayName": "Subdomain", "name": "subdomain", "type": "string", "default": "", "hint": "The subdomain can be extracted from the URL. If the URL is: https://dev99890.service-now.com the subdomain is dev99890", "required": true } ], "authenticate": { "type": "generic", "properties": { "auth": { "username": "={{$credentials.user}}", "password": "={{$credentials.password}}" } } }, "test": { "request": { "baseURL": "=https://{{$credentials?.subdomain}}.service-now.com", "url": "/api/now/table/sys_user_role" } } }, { "name": "shopifyApi", "displayName": "Shopify API", "documentationUrl": "shopify", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/shopifyApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "required": true, "type": "string", "default": "" }, { "displayName": "Password", "name": "password", "required": true, "type": "string", "default": "" }, { "displayName": "Shop Subdomain", "name": "shopSubdomain", "required": true, "type": "string", "default": "", "description": "Only the subdomain without .myshopify.com" }, { "displayName": "Shared Secret", "name": "sharedSecret", "type": "string", "default": "" } ] }, { "name": "signl4Api", "displayName": "SIGNL4 Webhook", "documentationUrl": "signl4", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/signl4Api", "properties": [ { "displayName": "Team Secret", "name": "teamSecret", "type": "string", "default": "", "description": "The team secret is the last part of your SIGNL4 webhook URL" } ] }, { "name": "slackApi", "displayName": "Slack API", "documentationUrl": "slack", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/slackApi", "properties": [ { "displayName": "Access Token", "name": "accessToken", "type": "string", "default": "", "required": true } ], "authenticate": { "type": "generic", "properties": { "headers": { "Authorization": "=Bearer {{$credentials.accessToken}}" } } }, "test": { "request": { "baseURL": "https://slack.com", "url": "/api/users.profile.get" }, "rules": [ { "type": "responseSuccessBody", "properties": { "key": "ok", "value": false, "message": "Invalid access token" } } ] } }, { "name": "slackOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "Slack OAuth2 API", "documentationUrl": "slack", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/slackOAuth2Api", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://slack.com/oauth/v2/authorize" }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://slack.com/api/oauth.v2.access" }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "chat:write" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "user_scope=chat:write files:read files:write groups:read im:read mpim:read reactions:read reactions:write stars:read stars:write usergroups:write usergroups:read users.profile:read users.profile:write" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" } ] }, { "name": "smtp", "displayName": "SMTP", "documentationUrl": "smtp", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/smtp", "properties": [ { "displayName": "User", "name": "user", "type": "string", "default": "" }, { "displayName": "Password", "name": "password", "type": "string", "typeOptions": { "password": true }, "default": "" }, { "displayName": "Host", "name": "host", "type": "string", "default": "" }, { "displayName": "Port", "name": "port", "type": "number", "default": 465 }, { "displayName": "SSL/TLS", "name": "secure", "type": "boolean", "default": true } ] }, { "name": "sshPassword", "displayName": "SSH Password", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/sshPassword", "properties": [ { "displayName": "Host", "name": "host", "required": true, "type": "string", "default": "", "placeholder": "localhost" }, { "displayName": "Port", "name": "port", "required": true, "type": "number", "default": 22 }, { "displayName": "Username", "name": "username", "type": "string", "default": "" }, { "displayName": "Password", "name": "password", "type": "string", "typeOptions": { "password": true }, "default": "" } ] }, { "name": "sshPrivateKey", "displayName": "SSH Private Key", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/sshPrivateKey", "properties": [ { "displayName": "Host", "name": "host", "required": true, "type": "string", "default": "", "placeholder": "localhost" }, { "displayName": "Port", "name": "port", "required": true, "type": "number", "default": 22 }, { "displayName": "Username", "name": "username", "type": "string", "default": "" }, { "displayName": "Private Key", "name": "privateKey", "type": "string", "typeOptions": { "rows": 4 }, "default": "" }, { "displayName": "Passphrase", "name": "passphrase", "type": "string", "default": "", "description": "Passphase used to create the key, if no passphase was used leave empty" } ] }, { "name": "stripeApi", "displayName": "Stripe API", "documentationUrl": "stripe", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/stripeApi", "properties": [ { "displayName": "Secret Key", "name": "secretKey", "type": "string", "default": "" } ] }, { "name": "surveyMonkeyApi", "displayName": "SurveyMonkey API", "documentationUrl": "surveyMonkey", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/surveyMonkeyApi", "properties": [ { "displayName": "Access Token", "name": "accessToken", "type": "string", "default": "", "description": "The access token must have the following scopes:\n\t\t\t<ul>\n\t\t\t\t<li>Create/modify webhooks</li>\n\t\t\t\t<li>View webhooks</li>\n\t\t\t\t<li>View surveys</li>\n\t\t\t\t<li>View collectors</li>\n\t\t\t\t<li>View responses</li>\n\t\t\t\t<li>View response details</li>\n\t\t\t</ul>" }, { "displayName": "Client ID", "name": "clientId", "type": "string", "default": "" }, { "displayName": "Client Secret", "name": "clientSecret", "type": "string", "default": "" } ] }, { "name": "surveyMonkeyOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "SurveyMonkey OAuth2 API", "documentationUrl": "surveyMonkey", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/surveyMonkeyOAuth2Api", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://api.surveymonkey.com/oauth/authorize", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://api.surveymonkey.com/oauth/token", "required": true }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "surveys_read,collectors_read,responses_read,responses_read_detail,webhooks_write,webhooks_read" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" } ] }, { "name": "telegramApi", "displayName": "Telegram API", "documentationUrl": "telegram", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/telegramApi", "properties": [ { "displayName": "Access Token", "name": "accessToken", "type": "string", "default": "", "description": "Chat with the <a href=\"https://telegram.me/botfather\">bot father</a> to obtain the access token" } ], "test": { "request": { "baseURL": "=https://api.telegram.org/bot{{$credentials?.accessToken}}", "url": "/getMe", "method": "GET" } } }, { "name": "trelloApi", "displayName": "Trello API", "documentationUrl": "trello", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/trelloApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "" }, { "displayName": "API Token", "name": "apiToken", "type": "string", "default": "" }, { "displayName": "OAuth Secret", "name": "oauthSecret", "type": "string", "default": "" } ] }, { "name": "twilioApi", "displayName": "Twilio API", "documentationUrl": "twilio", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/twilioApi", "properties": [ { "displayName": "Auth Type", "name": "authType", "type": "options", "default": "authToken", "options": [ { "name": "Auth Token", "value": "authToken" }, { "name": "API Key", "value": "apiKey" } ] }, { "displayName": "Account SID", "name": "accountSid", "type": "string", "default": "" }, { "displayName": "Auth Token", "name": "authToken", "type": "string", "default": "", "displayOptions": { "show": { "authType": [ "authToken" ] } } }, { "displayName": "API Key SID", "name": "apiKeySid", "type": "string", "default": "", "displayOptions": { "show": { "authType": [ "apiKey" ] } } }, { "displayName": "API Key Secret", "name": "apiKeySecret", "type": "string", "typeOptions": { "password": true }, "default": "", "displayOptions": { "show": { "authType": [ "apiKey" ] } } } ] }, { "name": "typeformApi", "displayName": "Typeform API", "documentationUrl": "typeform", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/typeformApi", "properties": [ { "displayName": "Access Token", "name": "accessToken", "type": "string", "default": "" } ] }, { "name": "typeformOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "Typeform OAuth2 API", "documentationUrl": "typeform", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/typeformOAuth2Api", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://api.typeform.com/oauth/authorize", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://api.typeform.com/oauth/token", "required": true }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "webhooks:write webhooks:read forms:read" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "header" } ] }, { "name": "vonageApi", "displayName": "Vonage API", "documentationUrl": "vonage", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/vonageApi", "properties": [ { "displayName": "API Key", "name": "apiKey", "type": "string", "default": "" }, { "displayName": "API Secret", "name": "apiSecret", "type": "string", "default": "" } ] }, { "name": "webflowApi", "displayName": "Webflow API", "documentationUrl": "webflow", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/webflowApi", "properties": [ { "displayName": "Access Token", "name": "accessToken", "type": "string", "default": "" } ] }, { "name": "webflowOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "Webflow OAuth2 API", "documentationUrl": "webflow", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/webflowOAuth2Api", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://webflow.com/oauth/authorize", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://api.webflow.com/oauth/access_token", "required": true }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "", "description": "For some services additional query parameters have to be set which can be defined here", "placeholder": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" } ] }, { "name": "whatsAppApi", "displayName": "WhatsApp API", "documentationUrl": "whatsApp", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/whatsAppApi", "properties": [ { "displayName": "Access Token", "type": "string", "typeOptions": { "password": true }, "name": "accessToken", "default": "", "required": true }, { "displayName": "Bussiness Account ID", "type": "string", "name": "businessAccountId", "default": "", "required": true } ], "authenticate": { "type": "generic", "properties": { "headers": { "Authorization": "=Bearer {{$credentials.accessToken}}" } } }, "test": { "request": { "baseURL": "https://graph.facebook.com/v13.0", "url": "/", "ignoreHttpStatusErrors": true }, "rules": [ { "type": "responseSuccessBody", "properties": { "key": "error.type", "value": "OAuthException", "message": "Invalid access token" } } ] } }, { "name": "wooCommerceApi", "displayName": "WooCommerce API", "documentationUrl": "wooCommerce", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/wooCommerceApi", "properties": [ { "displayName": "Consumer Key", "name": "consumerKey", "type": "string", "default": "" }, { "displayName": "Consumer Secret", "name": "consumerSecret", "type": "string", "default": "" }, { "displayName": "WooCommerce URL", "name": "url", "type": "string", "default": "", "placeholder": "https://example.com" }, { "displayName": "Include Credentials in Query", "name": "includeCredentialsInQuery", "type": "boolean", "default": false, "description": "Whether credentials should be included in the query. Occasionally, some servers may not parse the Authorization header correctly (if you see a “Consumer key is missing” error when authenticating over SSL, you have a server issue). In this case, you may provide the consumer key/secret as query string parameters instead." } ] }, { "name": "wordpressApi", "displayName": "Wordpress API", "documentationUrl": "wordpress", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/wordpressApi", "properties": [ { "displayName": "Username", "name": "username", "type": "string", "default": "" }, { "displayName": "Password", "name": "password", "type": "string", "typeOptions": { "password": true }, "default": "" }, { "displayName": "Wordpress URL", "name": "url", "type": "string", "default": "", "placeholder": "https://example.com" } ] }, { "name": "xeroOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "Xero OAuth2 API", "documentationUrl": "xero", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/xeroOAuth2Api", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://login.xero.com/identity/connect/authorize" }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://identity.xero.com/connect/token" }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "offline_access accounting.transactions accounting.settings accounting.contacts" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "header" } ] }, { "name": "youTubeOAuth2Api", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/youTubeOAuth2Api", "extends": [ "googleOAuth2Api" ], "displayName": "YouTube OAuth2 API", "documentationUrl": "google", "properties": [ { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "https://www.googleapis.com/auth/youtube https://www.googleapis.com/auth/youtubepartner https://www.googleapis.com/auth/youtube.force-ssl https://www.googleapis.com/auth/youtube.upload https://www.googleapis.com/auth/youtubepartner-channel-audit" } ] }, { "name": "zendeskApi", "displayName": "Zendesk API", "documentationUrl": "zendesk", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/zendeskApi", "properties": [ { "displayName": "Subdomain", "name": "subdomain", "type": "string", "description": "The subdomain of your Zendesk work environment", "placeholder": "company", "default": "" }, { "displayName": "Email", "name": "email", "type": "string", "default": "" }, { "displayName": "API Token", "name": "apiToken", "type": "string", "default": "" } ], "test": { "request": { "baseURL": "=https://{{$credentials.subdomain}}.zendesk.com/api/v2", "url": "/ticket_fields.json" } } }, { "name": "zendeskOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "Zendesk OAuth2 API", "documentationUrl": "zendesk", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/zendeskOAuth2Api", "properties": [ { "displayName": "Subdomain", "name": "subdomain", "type": "string", "default": "", "description": "The subdomain of your Zendesk work environment", "required": true }, { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "=https://{{$self[\"subdomain\"]}}.zendesk.com/oauth/authorizations/new", "description": "URL to get authorization code. Replace {SUBDOMAIN_HERE} with your subdomain.", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "=https://{{$self[\"subdomain\"]}}.zendesk.com/oauth/tokens", "description": "URL to get access token. Replace {SUBDOMAIN_HERE} with your subdomain.", "required": true }, { "displayName": "Client ID", "name": "clientId", "type": "string", "default": "", "required": true }, { "displayName": "Client Secret", "name": "clientSecret", "type": "string", "default": "", "required": true }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "read write" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "", "description": "For some services additional query parameters have to be set which can be defined here", "placeholder": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" } ] }, { "name": "zohoOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "Zoho OAuth2 API", "documentationUrl": "zoho", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/zohoOAuth2Api", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "options", "options": [ { "name": "https://accounts.zoho.com/oauth/v2/auth", "value": "https://accounts.zoho.com/oauth/v2/auth", "description": "For the EU, AU, and IN domains" }, { "name": "https://accounts.zoho.com.cn/oauth/v2/auth", "value": "https://accounts.zoho.com.cn/oauth/v2/auth", "description": "For the CN domain" } ], "default": "https://accounts.zoho.com/oauth/v2/auth", "required": true }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "options", "options": [ { "name": "AU - https://accounts.zoho.com.au/oauth/v2/token", "value": "https://accounts.zoho.com.au/oauth/v2/token" }, { "name": "CN - https://accounts.zoho.com.cn/oauth/v2/token", "value": "https://accounts.zoho.com.cn/oauth/v2/token" }, { "name": "EU - https://accounts.zoho.eu/oauth/v2/token", "value": "https://accounts.zoho.eu/oauth/v2/token" }, { "name": "IN - https://accounts.zoho.in/oauth/v2/token", "value": "https://accounts.zoho.in/oauth/v2/token" }, { "name": "US - https://accounts.zoho.com/oauth/v2/token", "value": "https://accounts.zoho.com/oauth/v2/token" } ], "default": "https://accounts.zoho.com/oauth/v2/token", "required": true }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "ZohoCRM.modules.ALL,ZohoCRM.settings.all,ZohoCRM.users.all" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "access_type=offline" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "body" } ] }, { "name": "zoomApi", "displayName": "Zoom API", "documentationUrl": "zoom", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/zoomApi", "properties": [ { "displayName": "JWT Token", "name": "accessToken", "type": "string", "default": "" } ] }, { "name": "zoomOAuth2Api", "extends": [ "oAuth2Api" ], "displayName": "Zoom OAuth2 API", "documentationUrl": "zoom", "icon": "https://org-default.dev.imbrace.co/rest/credential-icon/zoomOAuth2Api", "properties": [ { "displayName": "Authorization URL", "name": "authUrl", "type": "hidden", "default": "https://zoom.us/oauth/authorize" }, { "displayName": "Access Token URL", "name": "accessTokenUrl", "type": "hidden", "default": "https://zoom.us/oauth/token" }, { "displayName": "Scope", "name": "scope", "type": "hidden", "default": "" }, { "displayName": "Auth URI Query Parameters", "name": "authQueryParameters", "type": "hidden", "default": "" }, { "displayName": "Authentication", "name": "authentication", "type": "hidden", "default": "header" } ] } ] } -
Example:
curl --location 'https://app-gateway.dev.imbrace.co/v1/backend/workflow/processed-credential-types' \ --header 'x-access-token: acc_f7124766-e633-429c-b24a-ab0421a202e3'
4. Create channel webwidget
Dismisses (removes) specific notifications from the user’s list. This is typically a soft delete from the client’s perspective. Use when the user explicitly dismisses one or multiple notifications (e.g., “Clear” button on an item).
-
Endpoint for Product:
POST https://app-gateway.imbrace.co/v3/backend/channels/_web -
Endpoint for Demo:
POST https://app-gateway.demo.imbrace.co/v3/backend/channels/_web -
Endpoint for Dev:
POST https://app-gateway.dev.imbrace.co/v3/backend/channels/_web -
Headers:
Content-Type:application/jsonx-access-token:Your Access TokenYour Access Token
-
Body:
{ "name": "Test api" } -
Result:
- Status code: 200 OK
{ "doc_name": "channel", "name": "Test api", "active": true, "is_deleted": false, "is_replace": false, "bot_id": "u_imbrace_bot", "business_unit_id": "bu_imbrace_testing", "organization_id": "org_imbrace", "version": 2, "project_id": null, "config": { "window_name": null, "window_logo": null, "chatbot_name": null, "chatbot_avatar": null, "welcome_message": null, "primary_color": null, "secondary_color": null, "background_color": null, "header_color": null, "font_size": null, "email_config": { "email": null, "subject_title": null, "profile_name": null, "action_button_text": null, "button_url": null, "e_signature_name": null, "e_signature_information": null, "e_signature_logo": null, "show_powered_by": false, "legal_disclaimer": null }, "_id": "68edbce06da47b93262e87b1", "type": "web" }, "_id": "ch_17ef7c0c-f612-4634-90f7-e1e640a2e22b", "public_id": "ch_17ef7c0c-f612-4634-90f7-e1e640a2e22b", "created_at": "2025-10-14T03:00:48.279Z", "workflow_id": "rHmUG9iQBSfFJOKKhcYHA", "credential_id": "336090", "updated_at": "2025-10-14T03:00:51.039Z", "is_init": true, "id": "ch_17ef7c0c-f612-4634-90f7-e1e640a2e22b" } -
Example:
curl --location 'https://app-gateway.dev.imbrace.co/v3/backend/channels/_web' \ --header 'x-access-token: acc_f7124766-e633-429c-b24a-ab0421a202e3' \ --header 'Content-Type: application/json' \ --data '{ "name": "Test api" }'
5. Get channel by channel id
-
Endpoint for Product:
GET https://app-gateway.imbrace.co/v1/backend/channels/ch_38a02d56-f2ca-484a-b422-186b0f360b9e -
Endpoint for Demo:
GET https://app-gateway.demo.imbrace.co/v1/backend/channels/ch_38a02d56-f2ca-484a-b422-186b0f360b9e -
Endpoint for Dev:
GET https://app-gateway.dev.imbrace.co/v1/backend/channels/ch_38a02d56-f2ca-484a-b422-186b0f360b9e -
Headers:
Content-Type:application/jsonx-access-token:Your Access TokenYour Access Token
-
Body:
-
Result:
- Status code: 200 OK
{ "_id": "ch_38a02d56-f2ca-484a-b422-186b0f360b9e", "doc_name": "channel", "name": "Web Widget 111", "active": true, "is_deleted": false, "is_replace": false, "bot_id": "u_imbrace_bot", "business_unit_id": "bu_imbrace_testing", "organization_id": "org_imbrace", "version": 2, "project_id": null, "config": { "email_config": { "email": "tesst@gmail.com", "subject_title": "iMbrace", "profile_name": "iMbrace", "action_button_text": "Return to Conversation", "button_url": "https://webapp.dev.imbrace.co", "e_signature_name": "", "e_signature_information": "", "show_powered_by": true, "legal_disclaimer": "This message has been sent as a part of discussion between [SENDER COMPANY’S NAME] and the addressee whose name is specified above. Should you receive this message by mistake, we ask that you inform us at your earliest possible experience. In this case, we also ask that you delete this message from your mailbox, and do not forward it or any part of it to anyone else. Thank you for your cooperation and understanding.", "e_signature_logo": null }, "window_name": "iMbrace", "window_logo": null, "chatbot_name": "iMbrace", "chatbot_avatar": null, "welcome_message": "Hi there! How can I help you today?", "primary_color": "#156df2", "secondary_color": "#eaebf2", "background_color": "#ffffff", "header_color": "#156df2", "font_size": "16", "_id": "68edbeac6da47b93262e8edc", "type": "web" }, "public_id": "ch_38a02d56-f2ca-484a-b422-186b0f360b9e", "created_at": "2025-10-14T02:54:04.277Z", "credential_id": "458715", "updated_at": "2025-10-14T02:54:07.114Z", "workflow_id": "1UvWa2GamUJwroSVPYfBU", "is_init": false, "id": "ch_38a02d56-f2ca-484a-b422-186b0f360b9e" } -
Example:
curl --location 'https://app-gateway.dev.imbrace.co/v1/backend/channels/ch_38a02d56-f2ca-484a-b422-186b0f360b9e' \ --header 'x-access-token: acc_f7124766-e633-429c-b24a-ab0421a202e3' \ --data ''
6. Active channel webwidget
-
Endpoint for Product:
PUT https://app-gateway.imbrace.co/v1/backend/channels/ch_38a02d56-f2ca-484a-b422-186b0f360b9e -
Endpoint for Demo:
PUT https://app-gateway.demo.imbrace.co/v1/backend/channels/ch_38a02d56-f2ca-484a-b422-186b0f360b9e -
Endpoint for Dev:
PUT https://app-gateway.dev.imbrace.co/v1/backend/channels/ch_38a02d56-f2ca-484a-b422-186b0f360b9e -
Headers:
Content-Type:application/jsonx-access-token:Your Access TokenYour Access Token
-
Body:
{ "active": true } -
Result:
- Status code: 200 OK
{ "_id": "ch_38a02d56-f2ca-484a-b422-186b0f360b9e", "doc_name": "channel", "name": "Web Widget 111", "active": true, "is_deleted": false, "is_replace": false, "bot_id": "u_imbrace_bot", "business_unit_id": "bu_imbrace_testing", "organization_id": "org_imbrace", "version": 2, "project_id": null, "config": { "email_config": { "email": "tesst@gmail.com", "subject_title": "iMbrace", "profile_name": "iMbrace", "action_button_text": "Return to Conversation", "button_url": "https://webapp.dev.imbrace.co", "e_signature_name": "", "e_signature_information": "", "show_powered_by": true, "legal_disclaimer": "This message has been sent as a part of discussion between [SENDER COMPANY’S NAME] and the addressee whose name is specified above. Should you receive this message by mistake, we ask that you inform us at your earliest possible experience. In this case, we also ask that you delete this message from your mailbox, and do not forward it or any part of it to anyone else. Thank you for your cooperation and understanding.", "e_signature_logo": null }, "window_name": "iMbrace", "window_logo": null, "chatbot_name": "iMbrace", "chatbot_avatar": null, "welcome_message": "Hi there! How can I help you today?", "primary_color": "#156df2", "secondary_color": "#eaebf2", "background_color": "#ffffff", "header_color": "#156df2", "font_size": "16", "_id": "68edbeac6da47b93262e8ec2", "type": "web" }, "public_id": "ch_38a02d56-f2ca-484a-b422-186b0f360b9e", "created_at": "2025-10-14T02:54:04.277Z", "credential_id": "458715", "updated_at": "2025-10-14T02:54:07.114Z", "workflow_id": "1UvWa2GamUJwroSVPYfBU", "is_init": false, "id": "ch_38a02d56-f2ca-484a-b422-186b0f360b9e" } -
Example:
curl --location --request PUT 'https://app-gateway.dev.imbrace.co/v1/backend/channels/ch_38a02d56-f2ca-484a-b422-186b0f360b9e' \ --header 'x-access-token: acc_f7124766-e633-429c-b24a-ab0421a202e3' \ --header 'Content-Type: application/json' \ --data '{ "active": true }'
7. Setup channel webwidget
-
Endpoint for Product:
PUT https://app-gateway.imbrace.co/v1/backend/channels/ch_38a02d56-f2ca-484a-b422-186b0f360b9e -
Endpoint for Demo:
PUT https://app-gateway.demo.imbrace.co/v1/backend/channels/ch_38a02d56-f2ca-484a-b422-186b0f360b9e -
Endpoint for Dev:
PUT https://app-gateway.dev.imbrace.co/v1/backend/channels/ch_38a02d56-f2ca-484a-b422-186b0f360b9e -
Headers:
Content-Type:application/jsonx-access-token:Your Access TokenYour Access Token
-
Body:
{ "is_init": false, "config": { "type": "web", "window_name": "iMbrace", "chatbot_name": "iMbrace", "welcome_message": "Hi there! How can I help you today?", "primary_color": "#156df2", "header_color": "#156df2", "background_color": "#ffffff", "font_size": "16", "secondary_color": "#eaebf2", "email_config": { "email": "tesst@gmail.com", "subject_title": "iMbrace", "profile_name": "iMbrace", "e_signature_name": "", "e_signature_information": "", "show_powered_by": true, "legal_disclaimer": "This message has been sent as a part of discussion between [SENDER COMPANY’S NAME] and the addressee whose name is specified above. Should you receive this message by mistake, we ask that you inform us at your earliest possible experience. In this case, we also ask that you delete this message from your mailbox, and do not forward it or any part of it to anyone else. Thank you for your cooperation and understanding.", "action_button_text": "Return to Conversation", "button_url": "https://webapp.dev.imbrace.co" } } } -
Result:
- Status code: 200 OK
{ "_id": "ch_38a02d56-f2ca-484a-b422-186b0f360b9e", "doc_name": "channel", "name": "Web Widget 111", "active": true, "is_deleted": false, "is_replace": false, "bot_id": "u_imbrace_bot", "business_unit_id": "bu_imbrace_testing", "organization_id": "org_imbrace", "version": 2, "project_id": null, "config": { "email_config": { "email": "tesst@gmail.com", "subject_title": "iMbrace", "profile_name": "iMbrace", "action_button_text": "Return to Conversation", "button_url": "https://webapp.dev.imbrace.co", "e_signature_name": "", "e_signature_information": "", "show_powered_by": true, "legal_disclaimer": "This message has been sent as a part of discussion between [SENDER COMPANY’S NAME] and the addressee whose name is specified above. Should you receive this message by mistake, we ask that you inform us at your earliest possible experience. In this case, we also ask that you delete this message from your mailbox, and do not forward it or any part of it to anyone else. Thank you for your cooperation and understanding.", "e_signature_logo": null }, "window_name": "iMbrace", "window_logo": null, "chatbot_name": "iMbrace", "chatbot_avatar": null, "welcome_message": "Hi there! How can I help you today?", "primary_color": "#156df2", "secondary_color": "#eaebf2", "background_color": "#ffffff", "header_color": "#156df2", "font_size": "16", "_id": "68edbeac6da47b93262e8edc", "type": "web" }, "public_id": "ch_38a02d56-f2ca-484a-b422-186b0f360b9e", "created_at": "2025-10-14T02:54:04.277Z", "credential_id": "458715", "updated_at": "2025-10-14T02:54:07.114Z", "workflow_id": "1UvWa2GamUJwroSVPYfBU", "is_init": false, "id": "ch_38a02d56-f2ca-484a-b422-186b0f360b9e" } -
Example:
curl --location --request PUT 'https://app-gateway.dev.imbrace.co/v1/backend/channels/ch_38a02d56-f2ca-484a-b422-186b0f360b9e' \ --header 'x-access-token: acc_f7124766-e633-429c-b24a-ab0421a202e3' \ --header 'Content-Type: application/json' \ --data '{ "is_init": false, "config": { "type": "web", "window_name": "iMbrace", "chatbot_name": "iMbrace", "welcome_message": "Hi there! How can I help you today?", "primary_color": "#156df2", "header_color": "#156df2", "background_color": "#ffffff", "font_size": "16", "secondary_color": "#eaebf2", "email_config": { "email": "tesst@gmail.com", "subject_title": "iMbrace", "profile_name": "iMbrace", "e_signature_name": "", "e_signature_information": "", "show_powered_by": true, "legal_disclaimer": "This message has been sent as a part of discussion between [SENDER COMPANY’S NAME] and the addressee whose name is specified above. Should you receive this message by mistake, we ask that you inform us at your earliest possible experience. In this case, we also ask that you delete this message from your mailbox, and do not forward it or any part of it to anyone else. Thank you for your cooperation and understanding.", "action_button_text": "Return to Conversation", "button_url": "https://webapp.dev.imbrace.co" } } }'
8. Create channel whatsApp
-
Endpoint for Product:
POST https://app-gateway.imbrace.co/v1/backend/channels/_whatsapp -
Endpoint for Demo:
POST https://app-gateway.demo.imbrace.co/v1/backend/channels/_whatsapp -
Endpoint for Dev:
POST https://app-gateway.dev.imbrace.co/v1/backend/channels/_whatsapp -
Headers:
Content-Type:application/jsonx-access-token:Your Access TokenYour Access Token
-
Body:
{ "name": "WhatsApp chih test", "config": { "type": "whatsapp", "access_key": "asfsadfsdafsdaaf", "phone_number": "0900000000", "phone_number_id": "0900000000", "business_account_id": "0900000000" } } -
Result:
- Status code: 200 OK
{ "doc_name": "channel", "name": "WhatsApp chih test", "active": false, "is_deleted": false, "is_replace": false, "bot_id": "u_imbrace_bot", "business_unit_id": "bu_imbrace_testing", "organization_id": "org_imbrace", "version": 1, "project_id": null, "config": { "access_key": "asfsadfsdafsdaaf", "phone_number": "0900000000", "phone_number_id": "0900000000", "business_account_id": "0900000000", "namespace": null, "signing_key": null, "use_facebook_login": false, "_id": "68edcaad6da47b93262f3796", "type": "whatsapp" }, "_id": "ch_1eaeb05e-8a61-4947-b5d4-126f9f71c6a1", "public_id": "ch_1eaeb05e-8a61-4947-b5d4-126f9f71c6a1", "created_at": "2025-10-14T03:59:41.299Z", "workflow_id": "12913", "credential_id": "4236", "updated_at": "2025-10-14T03:59:41.712Z", "is_init": false, "id": "ch_1eaeb05e-8a61-4947-b5d4-126f9f71c6a1" } -
Example:
curl --location 'https://app-gateway.dev.imbrace.co/v1/backend/channels/_whatsapp' \ --header 'X-Access-Token: acc_f7124766-e633-429c-b24a-ab0421a202e3' \ --header 'Content-Type: application/json' \ --data '{ "name": "WhatsApp chih test", "config": { "type": "whatsapp", "access_key": "asfsadfsdafsdaaf", "phone_number": "0900000000", "phone_number_id": "0900000000", "business_account_id": "0900000000" } }'
9. Update whatsApp channel
-
Endpoint for Product:
PUT https://app-gateway.imbrace.co/v1/backend/channels/_whatsapp -
Endpoint for Demo:
PUT https://app-gateway.demo.imbrace.co/v1/backend/channels/_whatsapp -
Endpoint for Dev:
PUT https://app-gateway.dev.imbrace.co/v1/backend/channels/_whatsapp -
Headers:
Content-Type:application/jsonx-access-token:Your Access TokenYour Access Token
-
Body:
{ "config":{ "access_key": "EAAMS5ntbTJgBOZCFq3gKCP4qXf2DpzxMYsQrm5TK9UsQmO6Nay0wp3iz1VDebICvZCJ0pqq2r2ZAzDg33i3J9lV0IvLPMMdri0dZCmEJoEYOixAXjpqsAjMMzJsXGa7GSn9BZBx1j547uU7ScatV5IL8ZA7YRomMZAQVQiZBNNwA8ZC7bBOt7RCi4yNjnbZBHRwrZA8PsR2kTZAXZCKOAFhTLELED64Mq8mAZD", "phone_number_id": "100408036390338", "business_account_id": "119795474432218" } } -
Result:
- Status code: 200 OK
{ "doc_name": "channel", "name": "WhatsApp chih test", "active": false, "is_deleted": false, "is_replace": false, "bot_id": "u_imbrace_bot", "business_unit_id": "bu_imbrace_testing", "organization_id": "org_imbrace", "version": 1, "project_id": null, "config": { "access_key": "asfsadfsdafsdaaf", "phone_number": "0900000000", "phone_number_id": "0900000000", "business_account_id": "0900000000", "namespace": null, "signing_key": null, "use_facebook_login": false, "_id": "68edcaad6da47b93262f3796", "type": "whatsapp" }, "_id": "ch_1eaeb05e-8a61-4947-b5d4-126f9f71c6a1", "public_id": "ch_1eaeb05e-8a61-4947-b5d4-126f9f71c6a1", "created_at": "2025-10-14T03:59:41.299Z", "workflow_id": "12913", "credential_id": "4236", "updated_at": "2025-10-14T03:59:41.712Z", "is_init": false, "id": "ch_1eaeb05e-8a61-4947-b5d4-126f9f71c6a1" }- Status code: 400 Bad Request
{ "code": 40000, "message": "Facebook whatsapp connection error", "error": { "message": "Error validating access token: Session has expired on Monday, 15-Jan-24 00:00:00 PST. The current time is Wednesday, 17-Jan-24 01:42:18 PST.", "type": "OAuthException", "code": 190, "error_subcode": 463, "fbtrace_id": "Ag8mdFbSPbXaWmxILjKJSHS" } } -
Example:
curl --location 'https://app-gateway.dev.imbrace.co/v2/channels/_whatsapp' \ --header 'X-Access-Token: acc_f7124766-e633-429c-b24a-ab0421a202e3' \ --data '{ "config":{ "access_key": "EAAMS5ntbTJgBOwWZA7ogGZBep96aU9VgBVubtzZCReTqt7fhpzYgR2jJOrmFklC3wN4jK56eMl48L8EHygZCTgd7carTMk3z4inBXZA66qh4rZANcuXRxZAU4o1EZA8q6sJZAqviSTtIByej8BLrhZCZBdt552SgBCfqw0fhnVaUARmwZClEWZAQItjWKkMT1ovLQFbjZCZCXnaI1z5oXrxbOTMtTpspjY5ugZDZD", "phone_number_id": "160234133850110", "business_account_id": "197646896770994" } }'
10. Create facebook channel
-
Endpoint for Product:
POST https://app-gateway.imbrace.co/v1/backend/channels/_facebook -
Endpoint for Demo:
POST https://app-gateway.demo.imbrace.co/v1/backend/channels/_facebook -
Endpoint for Dev:
POST https://app-gateway.dev.imbrace.co/v1/backend/channels/_facebook -
Headers:
Content-Type:application/jsonx-access-token:Your Access TokenYour Access Token
-
Body:
{ "access_token": "EAAPRNR4MaA8BO4nLLYKw1sQQV9aZBj1Ta8rDKcnWzbzsAHLNEMZCgqMSgIvL41dKCwmEzxO8B7spF9qsEzsLxbcW6phN3YdsilcG3gZCUzDSmo4D5qgClABvhOgMWN0EuZBFsjztz4NYzQBeC8DQrkx81zzGeVq9K2zzcdWZABlpPMzq7pm918iDg04yhTFis5cZBmr6lfHoyzTh3ZCwZBBKSgDxXAZDZD" } -
Result:
- Status code: 200 OK
{ "_id": "ch_8eff4f9b-965c-43c7-8806-35a743198e0b", "doc_name": "channel", "name": "Test 粉絲", "active": true, "is_deleted": true, "bot_id": "u_imbrace_bot", "business_unit_id": "bu_imbrace_testing", "organization_id": "org_imbrace", "config": { "_id": "665d7dfdaf3d8bdc72c93625", "type": "facebook" }, "public_id": "ch_8eff4f9b-965c-43c7-8806-35a743198e0b", "created_at": "2024-06-03T08:25:33.362Z", "credential_id": "8", "updated_at": "2024-06-03T08:27:19.317Z", "workflow_id": "8", "is_init": false, "id": "ch_8eff4f9b-965c-43c7-8806-35a743198e0b" }- Status code: 403 Forbidden
{ "code": 40003, "message": "free version limitation: you can only create 1 channels." }- Status code: 400 Bad Request
{ "code": 40000, "message": "Invalid facebook access token", "error": { "message": "Error validating access token: Session has expired on Friday, 31-May-24 04:00:00 PDT. The current time is Sunday, 02-Jun-24 23:49:50 PDT.", "type": "OAuthException", "code": 190, "error_subcode": 463, "fbtrace_id": "ABgiGrhiZsi6ZxqEBfTGozY" } }- Status code: 500 Internal Server Error
{ "code": 99999, "message": "Internal Server Error", "error": { "message": "connect ECONNREFUSED 127.0.0.1:56789", "name": "Error", "stack": "Error: connect ECONNREFUSED 127.0.0.1:56789\n at TCPConnectWrap.afterConnect [as oncomplete] (node:net:1278:16)\n at TCPConnectWrap.callbackTrampoline (node:internal/async_hooks:130:17)", "config": { "transitional": { "silentJSONParsing": true, "forcedJSONParsing": true, "clarifyTimeoutError": false }, "transformRequest": [ null ], "transformResponse": [ null ], "timeout": 0, "xsrfCookieName": "XSRF-TOKEN", "xsrfHeaderName": "X-XSRF-TOKEN", "maxContentLength": -1, "maxBodyLength": -1, "env": {}, "headers": { "Accept": "application/json, text/plain, */*", "Content-Type": "application/json", "User-Agent": "axios/0.27.2", "Content-Length": 54 }, "httpsAgent": { "_events": {}, "_eventsCount": 0, "timeout": null, "maxFreeSockets": 1, "maxSockets": 1, "maxTotalSockets": null, "sockets": {}, "freeSockets": {}, "requests": {}, "options": {}, "secureProxy": false, "proxy": { "protocol": "http:", "slashes": true, "auth": null, "host": "dev-proxy.imbrace.co", "port": 8080, "hostname": "dev-proxy.imbrace.co", "hash": null, "search": null, "query": null, "href": "http://dev-proxy.imbrace.co:8080/" } }, "method": "post", "url": "http://localhost:56789/rest/login", "data": "{\"email\":\"jane.lin@imbrace.co\",\"password\":\"35Imbrace\"}" }, "code": "ECONNREFUSED", "status": null } } -
Example:
curl --location 'https://app-gateway.dev.imbrace.co/v1/backend/channels/_facebook' \ --header 'X-Access-Token: acc_f7124766-e633-429c-b24a-ab0421a202e3' \ --data '{ "access_token": "EAAPRNR4MaA8BOZBZCBuewcN9XI3Q6HT7IJebL1m9ad4VcMKDEh6qz4EtskN3eApg7D4tHqFrOCl1OfZClWukHADsLGB8vhY1GWBqJaeihc9sZCJI0rYJ2ZB7VH0UvDDvraMBJ6nYAl4poZAHCEHLOEoMkJZCglv13WIlnBWtvZBGgGcNTZC0mYP9VAAEymkinoUBARhTSJ1qakSFiLSoqrBnAr9sfewZDZD" }'
11. Update facebook channel
-
Endpoint for Product:
PUT https://app-gateway.imbrace.co/v1/backend/channels/_facebook -
Endpoint for Demo:
PUT https://app-gateway.demo.imbrace.co/v1/backend/channels/_facebook -
Endpoint for Dev:
PUT https://app-gateway.dev.imbrace.co/v1/backend/channels/_facebook -
Headers:
Content-Type:application/jsonx-access-token:Your Access TokenYour Access Token
-
Body:
{ "access_token": "hoyhlugtgtgtgtgtgtgtu" } -
Result:
- Status code: 200 OK
{ "_id": "ch_160560b6-7893-4db5-bd89-3c9fc101ac87", "doc_name": "channel", "name": "chih test", "active": true, "is_deleted": false, "bot_id": "u_imbrace_bot", "business_unit_id": "bu_imbrace_testing", "organization_id": "org_imbrace", "config": { "page_id": "116288408198623", "page_name": "chih test", "page_token": "EAAPRNR4MaA8BOZBF0fqUCszD8Uve7iLfZApPlz4zHt5ousmsEldZCLr9D3vcHAicpMz7ocyxnLZCGLYEgNjTxrOO6DIvTaK6zsnsrOeWQmIBzyjnftTIEljTIYmFOZB1hkNdFM2CdU0ZCIwGNB3Cl1OAcbgmdMQqzSk5NDBWpKIJZBEQ1vSvs982n2ezTgQEN14IZCWoa6EZD", "fb_user_id": "149499934528475", "fb_long_lived_token": "EAAPRNR4MaA8BOZCNsZCI90ekwglN2kXgt7GRlZCW7oGlu1ZAxV5zdT4iOcVE9RSUv1QjPTSvaiZAkZCdXOJhXspu1NsVQUa2mjLWi03XWhv4ZCoiYNTBj4EKljuZAAljDcHZAZBDkqjZBK0kjsk9yxRi1wlFKhKAsSABzUr0mzznXHiafLRwBFA7ovFYXfZBEsoP4HRY", "_id": "665d7dfcaf3d8bdc72c93622", "type": "facebook" }, "public_id": "ch_160560b6-7893-4db5-bd89-3c9fc101ac87", "created_at": "2024-06-03T08:25:32.885Z", "credential_id": "7", "updated_at": "2024-06-03T08:43:54.380Z", "workflow_id": "7", "is_init": false, "id": "ch_160560b6-7893-4db5-bd89-3c9fc101ac87" }- Status code: 400 Bad Request
{ "code": 40000, "message": "Invalid facebook access token", "error": { "message": "Invalid OAuth access token - Cannot parse access token", "type": "OAuthException", "code": 190, "fbtrace_id": "AJIwfVQaSNDh4MG5_HwA91Z" } } -
Example:
curl --location --request PUT 'https://app-gateway.dev.imbrace.co/v2/backend/channels/_facebook' \ --header 'X-Access-Token: acc_f7124766-e633-429c-b24a-ab0421a202e3' \ --data '{ "access_token": "asdasdsad" }'
12. Delete channel
-
Endpoint for Product:
DELETE https://app-gateway.imbrace.co/v1/backend/channels/:id -
Endpoint for Demo:
DELETE https://app-gateway.demo.imbrace.co/v1/backend/channels/:id -
Endpoint for Dev:
DELETE https://app-gateway.dev.imbrace.co/v1/backend/channels/:id -
Headers:
Content-Type:application/jsonx-access-token:Your Access TokenYour Access Token
-
Params (Path Variables):
id:ch_7666c70b-b8ca-4425-8052-adc712a8f3bd
-
Body:
-
Result:
- Status code: 200 OK
{ "message": "Channel deleted" }- Status code: 404 Not Found
{ "code": 40004, "message": "Channel not found" } -
Example:
curl --location --request DELETE 'https://app-gateway.dev.imbrace.co/v1/backend/channels/ch_7666c70b-b8ca-4425-8052-adc712a8f3bd' \ --header 'X-Access-Token: acc_f7124766-e633-429c-b24a-ab0421a202e3'
Board Apis
Board APIs focus on managing the data within the Data Board, including Create, Update, Delete operations for requests, orders, and other data records. These APIs also support exporting data in formats such as CSV for easier sharing and analysis.
Contacts apis
The Contacts APIs provide a centralized way to manage users, their contact information, and communication history across multiple channels. These APIs are essential for building a unified customer or user communication system. They allow you to