Skip to content

Uncanny Automator — Actions

WPsigner actions run only when the recipe is a published Automator recipe (uo-recipe or uw_recipe). Draft recipes fail with a clear log error.

All actions set requires_user to false so Everyone recipes can create and send documents.


ActionCodeWhat it does
Create a WPsigner document from a templateWPS_CREATE_SEND_DOCUMENTBuilds a document, maps signers, optional prefill, optional send
Send a documentWPS_SEND_DOCUMENTSends signing invitations for an existing document ID
Send a reminderWPS_SEND_REMINDEREmail reminders for pending/viewed signers (optional email filter)
Cancel a documentWPS_CANCEL_DOCUMENTSets status to cancelled if the document is still open
Add a tagWPS_ADD_TAGAttaches a tag without removing existing ones (max 5)
Add a signerWPS_ADD_SIGNERAdds a signer; optionally sends if the document is already sent/viewed
Set expirationWPS_SET_EXPIRATIONSets expires_at, or clears it when the field is empty (max 5 years ahead)
Get signersWPS_GET_SIGNERSExposes emails, JSON lists, and pending count as action tokens

Recipe fields:

FieldRequiredNotes
TemplateYesNo “Any” option — pick a real template
Required signers for this templateNoAJAX hint after you pick a template
Document titleNoEmpty → template name + current date/time
Send for signing immediatelyYesYes / create as draft
Signing workflowYesParallel or sequential
Use the recipe user as signer 1YesFills signer 1 from the recipe user when that email is empty
Signer 1–5 name/emailSigner emails as required by the templateExtra empty slots are ignored
Prefill template variablesNoJSON object or key=value lines

The AJAX hint uses Automator’s recipe-builder auth check (wpsua_get_template_meta). If it fails, you can still fill slots 1–5 manually.

Template slots must cover every signer_order used on the template. Missing slot → This template requires a signer for slot N.

Keys must match the template Mapping name (or field key). Same keys as form feeds / Zapier.

JSON:

{"client_name":"{{BILLING_FIRST_NAME}}","company":"Acme"}

Or lines:

client_name={{BILLING_FIRST_NAME}}
company=Acme

Rules:

  • Automator tokens in values are parsed before WPsigner fills fields
  • Maximum 40 keys; key ≤ 80 characters; value ≤ 500 characters
  • Signature, initials, label, attachment, image, and stamp fields are never prefilled
  • Prefill runs after create and before send, so the emailed PDF can include values

Action tokens after create include document ID, title, status, admin URL, sent yes/no, signer 1–3 emails/URLs (when allowed), field JSON, and FIELD_* values.


These call WPsigner’s existing messaging classes. They do not store API keys in Automator.

ActionCodeChannel
Send a reminder via channelWPS_SEND_CHANNEL_REMINDERWhatsApp, SMS (Twilio), Slack, Telegram, or Teams
Send a Slack message via WPsignerWPS_SEND_SLACK_MESSAGECustom text through the Slack webhook already configured in WPsigner

Channel reminders require:

  1. The matching integration enabled and configured in WPsigner
  2. Document status sent or viewed
  3. Pending/viewed signers (optional email filter)

WhatsApp and SMS also need a valid phone number on the signer. Telegram needs a chat ID WPsigner can resolve for that signer. If the channel cannot send, the action fails with an explicit error — it does not silently skip.

Configure channels: WhatsApp, Twilio, Slack, Telegram, Teams.

Slack custom messages are stripped of HTML, capped at 2,000 characters, and rate-limited. Do not paste secrets. Signing URLs appear only if you insert that token.


LimitDefaultOverride
Send / remind / channel cooldown20 seconds per document (or channel)Transient wpsua_rl_*
Slack custom message cooldown20 seconds globalSame
Automated creates60 per hourSettings or wpsua_max_creates_per_hour
Signers on create5 (max 10)Settings or wpsua_max_signers

Exceeded limits return a log error, not a partial send.