Integration StudioConnector Reference
All 15+ built-in connector types with auth configuration, every available operation, and payload schemas.
Connector Anatomy
A connector has two parts: config (credentials, base URL, auth method) stored once and encrypted, and operations (actions and triggers) that use that config at runtime. Operations are available as workflow action nodes.
rest_api — Generic REST
Connect to any REST API that isn't covered by a named connector.
| Field | Type | Required | Default | Description |
|---|
| baseUrl | string | required | — | Base URL prepended to all operation paths. |
| authType | enum | required | — | none · bearer · api_key · basic · oauth2_client_credentials · oauth2_authorization_code · custom_header |
| token | string | optional | — | For authType=bearer: the Bearer token value. |
| apiKey | string | optional | — | For authType=api_key: the API key value. |
| apiKeyHeader | string | optional | X-API-Key | Header name for the API key. |
| username | string | optional | — | For authType=basic: username. |
| password | string | optional | — | For authType=basic: password. |
| headers | object | optional | — | Default headers added to every request from this connector. |
| tlsVerify | boolean | optional | true | Verify TLS certificate. Set to false for self-signed certs in dev only. |
| timeout | integer | optional | 30000 | Request timeout in ms. |
Operations
- •
request — Make a single HTTP request: { method, path, headers, queryParams, body } - •
paginate — Make paginated requests and collect all pages: { method, path, pageParam, pageSize, dataPath }
slack
| Field | Type | Required | Default | Description |
|---|
| token | string | required | — | Slack Bot User OAuth Token (xoxb-...). Bot must be in the target channels. |
Operations
| Operation | Key Inputs | Key Outputs |
|---|
| postMessage | channel, text, blocks?, attachments? | messageId, timestamp, channel |
| updateMessage | channel, timestamp, text, blocks? | messageId |
| deleteMessage | channel, timestamp | ok |
| addReaction | channel, timestamp, name | ok |
| uploadFile | channels, filename, content, comment? | fileId, permalink |
| getUser | email or userId | userId, name, email, status |
| listChannels | types?, cursor?, limit? | channels[], nextCursor |
| createChannel | name, isPrivate? | channelId, name |
| inviteToChannel | channel, users[] | ok |
| sendDM | userId, text, blocks? | messageId |
jira
| Field | Type | Required | Default | Description |
|---|
| baseUrl | string | required | — | Your Jira Cloud URL: https://yourcompany.atlassian.net |
| email | string | required | — | Atlassian account email for the API token user. |
| apiToken | string | required | — | Atlassian API token (manage at id.atlassian.com). |
Operations
- •
createIssue — { project, summary, issueType, priority?, description?, assignee?, labels?, customFields? } → { issueId, issueKey, url } - •
updateIssue — { issueKey, fields } - •
transitionIssue — { issueKey, transitionId, comment? } - •
addComment — { issueKey, body } → { commentId } - •
getIssue — { issueKey, expand? } → full issue object - •
searchIssues — { jql, fields?, maxResults? } → issues array - •
createSprint — { boardId, name, startDate, endDate } - •
getUser — { email or accountId } - •
listProjects — → projects array - •
uploadAttachment — { issueKey, filename, content }
github
| Field | Type | Required | Default | Description |
|---|
| token | string | required | — | GitHub Personal Access Token or GitHub App installation token. |
| org | string | optional | — | Default organisation/owner. Can be overridden per operation. |
Operations
- •
createIssue — { owner, repo, title, body?, labels?, assignees? } - •
updateIssue — { owner, repo, number, state?, title?, body? } - •
createPR — { owner, repo, title, head, base, body? } - •
mergePR — { owner, repo, number, mergeMethod? } - •
createDeployment — { owner, repo, ref, environment, payload? } - •
updateDeploymentStatus — { owner, repo, deploymentId, state, logUrl? } - •
triggerWorkflow — { owner, repo, workflowId, ref, inputs? } - •
createComment — { owner, repo, issueNumber, body } - •
searchCode — { query, page? } - •
listRepos — { org?, type?, sort? }
| Field | Type | Required | Default | Description |
|---|
| apiKey | string | required | — | PagerDuty REST API key (v2). |
| eventsApiKey | string | optional | — | PagerDuty Events API v2 integration key (for event triggering). |
Operations
- •
triggerAlert — { routingKey, summary, source, severity, payload? } → { dedupKey } - •
resolveAlert — { routingKey, dedupKey } - •
acknowledgeAlert — { routingKey, dedupKey } - •
createIncident — { title, serviceId, urgency?, body?, escalationPolicy? } - •
updateIncident — { incidentId, status?, title?, assignments? } - •
getOnCall — { scheduleId } → current on-call user - •
listSchedules — → schedules array - •
listServices — → services array - •
snoozeIncident — { incidentId, duration }
aws
| Field | Type | Required | Default | Description |
|---|
| accessKeyId | string | required | — | AWS Access Key ID. |
| secretAccessKey | string | required | — | AWS Secret Access Key. |
| region | string | required | — | Default AWS region (e.g. us-east-1). |
| sessionToken | string | optional | — | Temporary session token for assumed roles. |
Operations (EC2, S3, CloudWatch, SNS, SQS, Lambda)
- •
ec2.describeInstances / ec2.startInstances / ec2.stopInstances - •
s3.putObject / s3.getObject / s3.listObjects / s3.deleteObject - •
cloudwatch.putMetricData / cloudwatch.getMetricData / cloudwatch.describeAlarms - •
sns.publish — { topicArn, message, subject?, attributes? } - •
sqs.sendMessage / sqs.receiveMessage / sqs.deleteMessage - •
lambda.invoke — { functionName, payload, invocationType? } - •
secretsManager.getSecret / secretsManager.putSecret
postgres / mysql
| Field | Type | Required | Default | Description |
|---|
| host | string | required | — | Database hostname or IP. |
| port | integer | optional | 5432/3306 | Port number. |
| database | string | required | — | Database name. |
| username | string | required | — | Database username. |
| password | string | required | — | Database password. |
| ssl | boolean | optional | true | Require SSL connection. |
| sslCert | string | optional | — | PEM-encoded client certificate for mTLS. |
Operations
- •
query — { sql, parameters? } → { rows, rowCount }. Read and write SQL. - •
execute — { sql, parameters? } → { rowsAffected }. Mutations without returning rows. - •
transaction — { statements: [{ sql, parameters }] }. Runs in a transaction; rolls back on error.
okta
| Field | Type | Required | Default | Description |
|---|
| domain | string | required | — | Okta domain: https://yourorg.okta.com |
| apiToken | string | required | — | Okta SSWS API token. |
Operations
- •
getUser / createUser / updateUser / deactivateUser / deleteUser - •
addUserToGroup / removeUserFromGroup / listUserGroups - •
assignAppToUser / removeAppFromUser - •
sendResetPasswordEmail — { login } - •
listUsers — { filter?, search?, limit? }
smtp
| Field | Type | Required | Default | Description |
|---|
| host | string | required | — | SMTP server hostname. |
| port | integer | optional | 587 | SMTP port (587 for STARTTLS, 465 for SSL, 25 for unencrypted). |
| secure | boolean | optional | true | Use TLS. |
| username | string | optional | — | SMTP auth username. |
| password | string | optional | — | SMTP auth password. |
| fromEmail | string | required | — | Default from address. |
| fromName | string | optional | — | Default from display name. |
Operations
- •
sendEmail — { to, cc?, bcc?, replyTo?, subject, text?, html?, attachments? } → { messageId, accepted } - •
sendTemplate — { to, templateId, variables, subject? } (uses Email Studio templates)
salesforce
| Field | Type | Required | Default | Description |
|---|
| instanceUrl | string | required | — | Your Salesforce instance URL: https://yourorg.salesforce.com |
| clientId | string | required | — | Connected App consumer key. |
| clientSecret | string | required | — | Connected App consumer secret. |
| refreshToken | string | required | — | OAuth 2.0 refresh token from initial authorization. |
Operations
- •
createRecord / updateRecord / deleteRecord / getRecord — { objectType, ... } - •
query — { soql } → records array - •
search — { sosl } → records array - •
bulkCreate / bulkUpdate — up to 10,000 records via Bulk API 2.0
graphql
| Field | Type | Required | Default | Description |
|---|
| endpoint | string | required | — | GraphQL API endpoint URL. |
| headers | object | optional | — | Auth and other default headers. |
| wsEndpoint | string | optional | — | WebSocket endpoint for subscription support. |
Operations
- •
query — { query, variables? } → { data, errors? } - •
mutate — { mutation, variables? } → { data, errors? }
webhook (outbound)
Send outbound HTTP payloads to any URL, with retry logic and optional HMAC signing.
| Field | Type | Required | Default | Description |
|---|
| url | string | required | — | Target URL. |
| method | enum | optional | POST | HTTP method. |
| secret | string | optional | — | HMAC secret. If set, adds X-Signature-256 header. |
| headers | object | optional | — | Default headers. |
| retries | integer | optional | 3 | Number of retry attempts on failure. |
| timeoutMs | integer | optional | 10000 | Request timeout. |
Operations
- •
send — { body, headers?, method? } → { status, responseBody, durationMs }