API reference
Cloud provider activities
AWS, Azure and Google Cloud storage, queues, messaging and secrets.
AWS, Azure and Google Cloud storage, queues, messaging and secrets. This page covers 12 activity types.
aws_s3#
AWS S3. Upload, download, delete, list, copy, and check objects in Amazon S3
Operations: upload, download, delete, list, exists, get_url, copy. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
bucket |
string | Yes | S3 bucket name |
key |
string | Yes | S3 object key (path within the bucket) Used when operation is upload, download, delete, exists, get_url. |
region |
string | No | AWS region (e.g. us-east-1). Inferred from IAM role if omitted. |
accessKey |
string | No | AWS access key ID (omit to use IAM instance role) |
secretKey |
string | No | AWS secret access key (omit to use IAM instance role) Secret: stored encrypted. |
content |
string | Yes | Object content as text (upload operation) Used when operation is upload. |
contentType |
string | No | Object content type (upload operation, default: text/plain) Used when operation is upload. |
prefix |
string | No | Only list keys starting with this prefix (list operation) Used when operation is list. |
maxItems |
number | No | Maximum keys to return (list operation, default: 100) Used when operation is list. |
expiryMinutes |
number | No | Pre-signed URL expiry in minutes (get_url operation, default: 60) Used when operation is get_url. |
sourceKey |
string | Yes | Source object key, within the same bucket (copy operation) Used when operation is copy. |
destKey |
string | Yes | Destination object key (copy operation) Used when operation is copy. |
destBucket |
string | No | Destination bucket (copy operation, default: same bucket) Used when operation is copy. |
| Output | Type | Description |
|---|---|---|
output.content |
string | Downloaded object content (download operation) |
output.success |
boolean | Whether the operation succeeded |
output.url |
string | Pre-signed URL (get_url operation) |
output.exists |
boolean | Whether the object exists (exists operation) |
output.objects |
array | Array of S3 object entries (list operation) |
Config block example:
{
"aws_s3": {
"operation": "upload",
"region": "us-east-1"
}
}
aws_secrets#
AWS Secrets Manager. Get, set, delete, and list secrets in AWS Secrets Manager
Operations: get_secret, set_secret, delete_secret, list_secrets. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
secretId |
string | Yes | Secret name or ARN Used when operation is get_secret, set_secret, delete_secret. |
region |
string | No | AWS region (e.g. us-east-1) |
accessKey |
string | No | AWS access key ID (omit to use IAM instance role) |
secretKey |
string | No | AWS secret access key (omit to use IAM instance role) Secret: stored encrypted. |
secretValue |
string | Yes | Secret value to store (set_secret operation) Used when operation is set_secret. |
versionStage |
string | No | Version stage label to retrieve (get_secret, default: AWSCURRENT) Used when operation is get_secret. |
forceDelete |
boolean | No | Delete immediately without recovery window (delete_secret) Used when operation is delete_secret. |
recoveryWindowDays |
number | No | Scheduled deletion recovery window in days (delete_secret, default: 30) Used when operation is delete_secret. |
| Output | Type | Description |
|---|---|---|
output.value |
string | Retrieved secret value (get_secret operation) |
output.arn |
string | Secret ARN |
output.success |
boolean | Whether the operation succeeded |
output.secrets |
array | Array of secret metadata objects (list_secrets operation) |
Config block example:
{
"aws_secrets": {
"operation": "get_secret",
"region": "us-east-1"
}
}
aws_sns#
AWS SNS. Publish messages, manage subscriptions, and list subscriptions in Amazon SNS topics
Operations: publish, subscribe, unsubscribe, list_subscriptions. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
topicArn |
string | Yes | SNS topic ARN Used when operation is publish, subscribe, list_subscriptions. |
region |
string | No | AWS region (e.g. us-east-1) |
accessKey |
string | No | AWS access key ID (omit to use IAM instance role) |
secretKey |
string | No | AWS secret access key (omit to use IAM instance role) Secret: stored encrypted. |
message |
string | Yes | Message to publish (publish operation) Used when operation is publish. |
subject |
string | No | Email subject line (publish to email subscriptions) Used when operation is publish. |
protocol |
string | Yes | Subscription protocol: email, sqs, http, https, lambda, application, sms, firehose (subscribe) Used when operation is subscribe. Allowed values: email, sqs, http, https, lambda, application, sms, firehose. |
endpoint |
string | Yes | Subscription endpoint (subscribe operation) Used when operation is subscribe. |
subscriptionArn |
string | Yes | Subscription ARN (unsubscribe operation) Used when operation is unsubscribe. |
| Output | Type | Description |
|---|---|---|
output.success |
boolean | Whether the operation succeeded |
output.messageId |
string | Published message ID (publish operation) |
output.subscriptionArn |
string | New subscription ARN (subscribe operation) |
output.subscriptions |
array | Array of subscription objects (list_subscriptions operation) |
Config block example:
{
"aws_sns": {
"operation": "publish",
"region": "us-east-1"
}
}
aws_sqs#
AWS SQS. Send, receive, delete, and manage messages in Amazon SQS queues
Operations: send, receive, delete, get_count, purge. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
queueUrl |
string | Yes | SQS queue URL |
region |
string | No | AWS region (e.g. us-east-1) |
accessKey |
string | No | AWS access key ID (omit to use IAM instance role) |
secretKey |
string | No | AWS secret access key (omit to use IAM instance role) Secret: stored encrypted. |
body |
string | Yes | Message body to enqueue (send operation) Used when operation is send. |
delaySeconds |
number | No | Delivery delay in seconds (send operation, default: 0) Used when operation is send. |
maxMessages |
number | No | Max messages to retrieve (receive, default: 1) Used when operation is receive. |
receiptHandle |
string | Yes | Receipt handle of the message to delete Used when operation is delete. |
visibilitySeconds |
number | No | [receive] Visibility timeout in seconds while the message is being processed (default: 30) Used when operation is receive. |
waitTimeSeconds |
number | No | [receive] Long-poll wait time in seconds, 0 = return immediately (default: 0) Used when operation is receive. |
| Output | Type | Description |
|---|---|---|
output.success |
boolean | Whether the operation succeeded |
output.messages |
array | Array of received message objects |
output.count |
number | Approximate number of visible messages (get_count operation) |
output.messageId |
string | ID of the sent message (send operation) |
Config block example:
{
"aws_sqs": {
"operation": "send",
"region": "us-east-1"
}
}
azure_blob#
Azure Blob Storage. Upload, download, delete, list, copy, and check objects in Azure Blob Storage
Operations: upload, download, delete, list, exists, copy, get_url. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
connectionString |
string | Yes | Azure Storage connection string (or omit for managed identity) Secret: stored encrypted. |
containerName |
string | Yes | Blob container name |
blobName |
string | Yes | Blob name / path within the container Used when operation is upload, download, delete, exists, get_url. |
content |
string | Yes | Content to upload as text (upload operation) Used when operation is upload. |
overwrite |
boolean | No | Overwrite the blob if it already exists (upload operation, default: true) Used when operation is upload. |
sourceBlobName |
string | Yes | Source blob name (copy operation) Used when operation is copy. |
destBlobName |
string | Yes | Destination blob name (copy operation) Used when operation is copy. |
prefix |
string | No | Only list blobs whose name starts with this prefix (list operation) Used when operation is list. |
maxItems |
number | No | Maximum items to return (list operation, default: 100) Used when operation is list. |
| Output | Type | Description |
|---|---|---|
output.content |
string | Downloaded blob content (download operation) |
output.success |
boolean | Whether the operation succeeded |
output.url |
string | Blob URL (get_url operation) |
output.exists |
boolean | Whether the blob exists (exists operation) |
output.blobs |
array | Array of blob entries (list operation) |
Config block example:
{
"azure_blob": {
"operation": "upload"
}
}
azure_keyvault#
Azure Key Vault. Get, set, delete, and list secrets in Azure Key Vault
Operations: get_secret, set_secret, delete_secret, list_secrets. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
vaultUri |
string | Yes | Key Vault URL (e.g. https://my-vault.vault.azure.net) |
secretName |
string | Yes | Secret name Used when operation is get_secret, set_secret, delete_secret. |
secretValue |
string | Yes | Secret value to store (set_secret operation) Used when operation is set_secret. |
secretVersion |
string | No | Secret version to retrieve (get_secret, default: latest) Used when operation is get_secret. |
| Output | Type | Description |
|---|---|---|
output.value |
string | Retrieved secret value (get_secret operation) |
output.name |
string | Secret name |
output.version |
string | Secret version identifier |
output.success |
boolean | Whether the operation succeeded |
Config block example:
{
"azure_keyvault": {
"operation": "get_secret"
}
}
azure_queue#
Azure Queue Storage. Send, receive, peek, delete, and manage messages in Azure Storage Queues
Operations: send, receive, peek, delete, get_count, clear. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
connectionString |
string | Yes | Azure Storage connection string Secret: stored encrypted. |
queueName |
string | Yes | Queue name |
message |
string | Yes | Message content to enqueue (send operation) Used when operation is send. |
maxMessages |
number | No | Maximum messages to retrieve (receive/peek, default: 1) Used when operation is receive, peek. |
visibilitySeconds |
number | No | Message invisibility timeout in seconds (receive, default: 30) Used when operation is receive. |
messageId |
string | Yes | Message ID for deletion (delete operation) Used when operation is delete. |
popReceipt |
string | Yes | Pop receipt for deletion (delete operation) Used when operation is delete. |
ttlSeconds |
number | No | Message TTL in seconds (send operation, default: no expiry) Used when operation is send. |
| Output | Type | Description |
|---|---|---|
output.success |
boolean | Whether the operation succeeded |
output.messages |
array | Array of received/peeked message objects |
output.count |
number | Approximate queue message count (get_count operation) |
output.messageId |
string | ID of the enqueued message (send operation) |
Config block example:
{
"azure_queue": {
"operation": "send"
}
}
azure_servicebus#
Azure Service Bus. Send, receive, peek, complete, dead-letter, and abandon messages on Azure Service Bus queues and topics
Operations: send, receive, peek, complete, dead_letter, abandon. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
connectionString |
string | Yes | Service Bus connection string Secret: stored encrypted. |
entityPath |
string | Yes | Queue or topic name |
body |
string | Yes | Message body to send (send operation) Used when operation is send. |
correlationId |
string | No | Correlation ID to stamp on the outgoing message (send operation) Used when operation is send. |
subject |
string | No | Subject/label to stamp on the outgoing message (send operation) Used when operation is send. |
maxMessages |
number | No | Maximum messages to receive (receive/peek, default: 1) Used when operation is receive, peek. |
waitSeconds |
number | No | Max wait time for messages in seconds (receive, default: 5) Used when operation is receive. |
lockToken |
string | Yes | Message lock token (complete/dead_letter/abandon operations) Used when operation is complete, dead_letter, abandon. |
reason |
string | No | Dead-letter reason (dead_letter operation, default: "DeadLettered by workflow") Used when operation is dead_letter. |
| Output | Type | Description |
|---|---|---|
output.success |
boolean | Whether the operation succeeded |
output.messages |
array | Array of received/peeked message objects |
output.count |
number | Number of messages returned |
output.messageId |
string | Enqueued message ID (send operation) |
Config block example:
{
"azure_servicebus": {
"operation": "send"
}
}
azure_table#
Azure Table Storage. Get, upsert, delete, and query entities in Azure Table Storage
Operations: get, upsert, delete, query, list. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
connectionString |
string | Yes | Azure Storage connection string Secret: stored encrypted. |
tableName |
string | Yes | Table name |
partitionKey |
string | Yes | Entity partition key (get/upsert/delete) Used when operation is get, upsert, delete. |
rowKey |
string | Yes | Entity row key (get/upsert/delete) Used when operation is get, upsert, delete. |
entity |
object | No | Entity data to upsert as a JSON object Used when operation is upsert. |
filter |
string | Yes | OData filter expression (query operation, e.g. PartitionKey eq 'orders') Used when operation is query. |
maxItems |
number | No | Maximum entities to return (query/list operation, default: 100) Used when operation is query, list. |
| Output | Type | Description |
|---|---|---|
output.entity |
object | Retrieved entity (get operation) |
output.entities |
array | Array of entities (query/list operation) |
output.success |
boolean | Whether the operation succeeded |
output.count |
number | Number of entities returned |
Config block example:
{
"azure_table": {
"operation": "upsert"
}
}
gcp_pubsub#
GCP Pub/Sub. Publish messages to Google Cloud Pub/Sub topics; pull from subscriptions and acknowledge messages
Operations: publish, subscribe, pull, acknowledge. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
projectId |
string | Yes | GCP project ID |
topicId |
string | Yes | Pub/Sub topic ID (publish/subscribe operations) Used when operation is publish, subscribe. |
subscriptionId |
string | Yes | Pub/Sub subscription ID (subscribe/pull/acknowledge operations) Used when operation is subscribe, pull, acknowledge. |
message |
string | Yes | Message data to publish (publish operation) Used when operation is publish. |
maxMessages |
number | No | Maximum messages to pull (pull operation, default: 10) Used when operation is pull. |
ackId |
string | Yes | Acknowledgment ID of the message to acknowledge (acknowledge operation, from a prior pull) Used when operation is acknowledge. |
| Output | Type | Description |
|---|---|---|
output.success |
boolean | Whether the operation succeeded |
output.messageId |
string | Published message ID (publish operation) |
output.messages |
array | Array of pulled message objects (pull operation) |
output.count |
number | Number of messages returned |
Config block example:
{
"gcp_pubsub": {
"operation": "publish"
}
}
gcp_secrets#
GCP Secret Manager. Get, set, delete, and list secrets in Google Cloud Secret Manager
Operations: get_secret, set_secret, delete_secret, list_secrets. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
projectId |
string | Yes | GCP project ID |
secretId |
string | Yes | Secret name Used when operation is get_secret, set_secret, delete_secret. |
secretValue |
string | Yes | Secret value to store (set_secret operation) Used when operation is set_secret. |
version |
string | No | Secret version to retrieve (get_secret, default: latest) Used when operation is get_secret. |
| Output | Type | Description |
|---|---|---|
output.value |
string | Retrieved secret value (get_secret operation) |
output.secretId |
string | Secret identifier |
output.version |
string | Version identifier |
output.success |
boolean | Whether the operation succeeded |
output.secrets |
array | Array of secret metadata objects (list_secrets operation) |
Config block example:
{
"gcp_secrets": {
"operation": "get_secret"
}
}
gcp_storage#
GCP Cloud Storage. Upload, download, delete, list, copy, and check objects in Google Cloud Storage
Operations: upload, download, delete, list, exists, get_url, copy. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
bucket |
string | Yes | GCS bucket name |
objectName |
string | Yes | Object name (path within the bucket) Used when operation is upload, download, delete, exists, get_url. |
projectId |
string | No | GCP project ID (inferred from ADC if omitted) |
content |
string | Yes | Object content as text (upload operation) Used when operation is upload. |
contentType |
string | No | Object content type (upload operation, default: text/plain) Used when operation is upload. |
prefix |
string | No | Only list objects starting with this prefix (list operation) Used when operation is list. |
maxItems |
number | No | Maximum objects to return (list operation, default: 100) Used when operation is list. |
sourceObjectName |
string | Yes | Source object name, within the same bucket (copy operation) Used when operation is copy. |
destObjectName |
string | Yes | Destination object name (copy operation) Used when operation is copy. |
destBucket |
string | No | Destination bucket (copy operation, default: same bucket) Used when operation is copy. |
| Output | Type | Description |
|---|---|---|
output.content |
string | Downloaded object content (download operation) |
output.success |
boolean | Whether the operation succeeded |
output.url |
string | Public object URL (get_url operation) |
output.exists |
boolean | Whether the object exists (exists operation) |
output.objects |
array | Array of GCS object entries (list operation) |
Config block example:
{
"gcp_storage": {
"operation": "upload"
}
}