Automation Actions

Available actions for your automation workflows

Actions are the operations performed by your automations. You add them as action steps in the automation builder and fill in their inputs.

There are twenty-six actions, and the list is a closed set — there is no mechanism for adding a custom action. If you need to reach a system Alguna does not cover, use send_webhook.

Every input can be a literal value or a reference to earlier data in the run, inserted from the variable picker on the field. See Template syntax.

---

Notifications

send_email

Sends a generic, customizable email to a customer.

Parameter	Type	Required	Description
accountId	string	Yes	The ID of the customer to send the email to
from	string	Yes	The sender email address
subject	string	Yes	The email subject line
body	string	Yes	The email body content in markdown format
previewText	string	No	Optional preview text shown in email clients before opening
overrideEmails	string[]	No	Optional list of email addresses to send to instead of the account’s primary email
cc	string[]	No	Optional list of email addresses to carbon copy
bcc	string[]	No	Optional list of email addresses to blind carbon copy
cta	object	No	Optional call-to-action button: text and link

Use cases: payment failure notices, usage threshold alerts, ad-hoc customer communication.

send_slack_message

Sends a Slack message to a selected Slack channel.

Parameter	Type	Required	Description
integrationId	string	Yes	The Slack workspace connection to use
channelId	string	Yes	The Slack channel to send the message to
messageBody	string	Yes	The Slack message body in markdown format

Pick a connected Slack workspace first, then a channel from that workspace. Channel options include public and private channels the connected Slack app can access. Workspace and channel are selected, not templated; the message body supports references to run data.

If Slack is not connected yet, users who can manage integrations can connect it inline from the action form. Others see helper text directing them to Settings → Integrations.

Use cases: high-value deal alerts, failed payment alerts, onboarding kickoff notifications.

send_webhook

Sends an HTTP POST request with a JSON body to a specified URL.

Parameter	Type	Required	Description
url	string	Yes	The URL to send the webhook to
body	string	Yes	The JSON body to send (must be valid JSON)
headers	object	No	Optional custom HTTP headers to include in the request

The request is always a POST. headers is a flat map of header name to value.

Use cases: syncing billing events into your own app, triggering an external workflow.

send_billing_info_request

Requests billing information from a customer via email.

Parameter	Type	Required	Description
accountId	string	Yes	The ID of the customer to request billing information from
subscriptionId	string	No	Optional subscription ID to associate with the request
captureBusinessInformation	boolean	No	Whether to request business information (company name, tax ID etc)
capturePaymentMethods	boolean	No	Whether to request payment method information
overrideEmails	string[]	No	Optional list of email addresses to send to instead of the account’s primary email
cc	string[]	No	Optional list of email addresses to carbon copy
bcc	string[]	No	Optional list of email addresses to blind carbon copy

Use cases: collecting a new payment method after a failure, chasing missing tax details.

share_customer_portal_link

Shares a link to the customer portal via email.

Parameter	Type	Required	Description
accountId	string	Yes	The ID of the customer to share the customer portal link with
customCopy	object	No	Optional custom copy: subject, body, ctaText. Defaults to the organization’s email copy
overrideEmails	string[]	No	Optional list of email addresses to send to instead of the account’s primary email
cc	string[]	No	Optional list of email addresses to carbon copy
bcc	string[]	No	Optional list of email addresses to blind carbon copy

---

Payments

send_card_expiration_reminder

Emails the customer a reminder that their stored card is expiring, with a link to update it.

Parameter	Type	Required	Description
accountId	string	Yes	The ID of the customer the expiring card belongs to
paymentMethodId	string	Yes	The ID of the expiring card payment method (from the Card Expiring trigger)
overrideEmails	string[]	No	Optional list of email addresses to send to instead of the account’s billing contacts
cc	string[]	No	Optional list of email addresses to carbon copy
bcc	string[]	No	Optional list of email addresses to blind carbon copy

Pair it with the card_expiring trigger, which supplies both parameters.

---

Invoicing

retry_invoice_payment

Retries payment for a failed invoice using the default payment method.

Parameter	Type	Required	Description
previousPaymentId	string	Yes	The ID of the previous failed payment attempt
invoiceId	string	Yes	The ID of the invoice to retry payment for

Both parameters come straight from the payment_failed trigger. The step outputs the new paymentId, its status and, on failure, a failureReason you can branch on.

send_invoice_reminder

Sends a reminder email for an issued or overdue invoice.

Parameter	Type	Required	Description
invoiceId	string	Yes	The ID of the invoice to send a reminder for
overrideEmails	string[]	No	Optional list of email addresses to send to instead of the default recipients
cc	string[]	No	Optional list of email addresses to carbon copy
bcc	string[]	No	Optional list of email addresses to blind carbon copy

send_invoice_reminders_bulk

Sends reminders for a list of invoices based on a set of filters. Normally preceded by get_invoices.

Parameter	Type	Required	Description
invoices	object[]	Yes	The list of invoices to send reminders for
status	string	No	Optional status to filter by: issued or overdue
accountIds	string[]	No	Optional list of customer IDs to filter by
dueInDays	integer[]	No	Exclude any issued invoice that does not match the specified number(s) of days until it is due
overdueDays	integer[]	No	Exclude any overdue invoice that does not match the specified number(s) of days overdue
overrideEmails	string[]	No	Optional list of email addresses to send to instead of the default recipients
cc	string[]	No	Optional list of email addresses to carbon copy
bcc	string[]	No	Optional list of email addresses to blind carbon copy

The step reports sentInvoices, failedInvoices and skippedInvoices, so a following step can act on what actually went out.

---

Subscriptions

cancel_subscription

Cancels a customer’s active subscription.

Parameter	Type	Required	Description
subscriptionId	string	Yes	The ID of the subscription to cancel
sendEmail	boolean	No	Whether to send a cancellation confirmation email to the customer
effectiveEndDate	date-time	No	When the cancellation takes effect. Without it, the subscription is cancelled at the end of the current billing period

send_subscriptions_autorenewal_notification_bulk

Sends auto-renewal notifications for a list of subscriptions based on a set of filters. Normally preceded by get_subscriptions.

Parameter	Type	Required	Description
subscriptions	object[]	Yes	The list of subscriptions to send auto-renewal notifications for
daysUntilRenewal	integer[]	No	Exclude any subscription that does not match the specified number(s) of days until renewal
customerIds	string[]	No	Optional list of customer IDs to filter by

---

Quotes

send_subscription_signature_reminder

Sends a reminder email for a subscription that requires signature.

Parameter	Type	Required	Description
subscriptionId	string	Yes	The ID of the subscription to send a signature reminder for
overrideEmails	string[]	No	Optional list of email addresses to send to instead of the default recipients
cc	string[]	No	Optional list of email addresses to carbon copy
bcc	string[]	No	Optional list of email addresses to blind carbon copy

create_quote

Mints a new, renewal, or amendment quote for an account, optionally linking it to a CRM opportunity.

Parameter	Type	Required	Description
kind	string	Yes	new, renewal, or amendment. Defaults to new
accountId	string	Yes	The account the quote is created for
planID	string	No	The plan a new quote is seeded from
subscriptionId	string	No	The subscription a renewal quote renews
opportunityId	string	No	A CRM opportunity to link the quote to once created

activate_quote

Marks a quote’s subscription signed offline, mirroring the dashboard’s manual offline-sign action.

Parameter	Type	Required	Description
quoteId	string	Yes	The quote whose subscription should be marked signed offline

---

CRM

These actions need a connected CRM integration. Where a parameter names a CRM record directly it is spelled recordID and integrationID, matching the CRM trigger payloads.

get_crm_opportunity

Reads a CRM opportunity and the Alguna account and quotes it correlates to. Useful as a lookup step before branching.

Parameter	Type	Required	Description
recordID	string	No	The opportunity’s id in the CRM. Provide this or quoteId, not both
integrationID	string	No	The CRM integration connection. Defaults to the organization’s connected CRM
quoteId	string	No	The quote whose linked CRM opportunity should be read. Provide this or recordID, not both

create_crm_record

Creates or updates the quote’s CRM record of the requested object type, or an account-anchored expansion Opportunity.

Parameter	Type	Required	Description
objectType	string	Yes	The CRM object type to write
quoteId	string	No	The quote the record projects, and the quote a created Opportunity is linked to
accountId	string	No	The account a quote-less Opportunity is created against (Opportunity only)
recordContext	string	No	Which mapping context to resolve the record’s fields from
stage	string	No	The pipeline stage a created Opportunity opens in (Opportunity only)
name	string	No	Optional Opportunity name override (Opportunity only)

update_crm_record

Writes billing and quote facts onto the subscription’s linked CRM opportunity.

Parameter	Type	Required	Description
quoteId	string	Yes	The quote whose linked CRM opportunity should be updated

set_opportunity_stage

Moves the stage of the opportunity linked to a quote. Opt in to this only when no CRM workflow of your own already moves the stage.

Parameter	Type	Required	Description
stage	string	Yes	The Opportunity stage to set
subscriptionId	string	No	Address the opportunity via the subscription’s CRM link
quoteId	string	No	Address the opportunity via the quote’s CRM link
recordID	string	No	Address the opportunity directly by its CRM record
integrationID	string	No	The CRM integration connection, only meaningful with recordID

Provide exactly one of subscriptionId, quoteId or recordID.

create_quote_from_opportunity

Mints a draft quote for a CRM opportunity’s customer and links the two, importing the customer when the deal has none here yet.

Parameter	Type	Required	Description
recordID	string	Yes	The opportunity’s id in the CRM
integrationID	string	Yes	The ID of the CRM integration connection
planID	string	No	A plan to seed the quote from. Left empty, the quote starts blank

void_open_quotes_for_opportunity

Withdraws every open quote linked to a CRM opportunity, cancelling their pending signature sessions.

Parameter	Type	Required	Description
recordID	string	No	The opportunity’s id in the CRM. Provide this or quoteId, not both
integrationID	string	No	The CRM integration connection, only meaningful with recordID
quoteId	string	No	A quote linked to the opportunity whose other open quotes should be voided

cancel_renewal_for_lost_opportunity

Schedules a subscription to stop auto-renewing at its current contract end date when its renewal Opportunity is marked lost in the CRM.

Parameter	Type	Required	Description
recordID	string	No	The opportunity’s id in the CRM. Provide this or quoteId, not both
integrationID	string	No	The CRM integration connection, only meaningful with recordID
quoteId	string	No	The renewal quote whose linked CRM opportunity was marked lost

---

Lookups and General

Lookup actions fetch data for later steps to branch on or act over. Their output is available as {{<stepId>.outputs.<field>}}.

get_invoice

Retrieves details of a specific invoice.

Parameter	Type	Required	Description
invoiceId	string	Yes	The ID of the invoice to retrieve

get_invoices

Retrieves a list of invoices based on filter criteria.

Parameter	Type	Required	Description
accountIds	string[]	No	List of customer IDs to filter invoices by
accountIdsToExclude	string[]	No	List of customer IDs to exclude from the results
statuses	string[]	No	List of invoice statuses to filter by

get_subscription

Retrieves details of a specific subscription.

Parameter	Type	Required	Description
subscriptionId	string	Yes	The ID of the subscription to retrieve

get_subscriptions

Retrieves a list of subscriptions based on filter criteria.

Parameter	Type	Required	Description
accountIds	string[]	No	List of customer IDs to filter subscriptions by
accountIdsToExclude	string[]	No	List of customer IDs to exclude from the results
statuses	string[]	No	List of subscription statuses to filter by
contractPeriodTypes	string[]	No	fixed or monthly_rolling
autoRenew	boolean	No	Filter by auto-renew setting

set_tags_on_entity

Sets tags on an invoice, subscription, or customer.

Parameter	Type	Required	Description
entityType	string	Yes	product, customer, plan, subscription, metric, or invoice
entityId	string	Yes	The ID of the entity to tag
tagIds	string[]	Yes	The tags to apply to the entity (at least one)

---

Workflow Control

Waiting and branching are step types rather than actions:

Step type	Purpose
delay	Waits a duration — seconds through years — before the next step
condition	Splits the flow into branches, each guarded by its own condition

There is no “stop” action. A branch simply ends when it has no further steps.

---

When an Action Does Nothing

Several actions can legitimately write nothing — a quote is already signed, an opportunity has no link, a stage already matches. Rather than failing, these report skipped or created: false along with a reason such as already_signed or no_linked_opportunity. The run continues, and the reason appears in the execution log. See Execution outcome reasons.

There is no per-action retry or fallback setting. Invalid inputs fail a step permanently; transient failures are retried by the workflow engine automatically.

---

Best Practices

Look Up Before You Act

Use a get action and a condition step to confirm state before sending or charging.

Prefer Bulk Actions

On scheduled runs, use the bulk reminder actions rather than one step per record.

Read the Outcome

Branch on an action’s outputs instead of assuming it did something.

Test Thoroughly

Test with real trigger data before activating.

---

Next Steps

Conditions

Add conditional logic to your automations.

Triggers

Configure what starts your automations.

Reference

Every parameter and output, in one place.