Built in parameters

Post parameters #

Post parameters become available whenever the trigger that starts the workflow provides a Post object.

ParameterDescription
post.idReturns the numeric post id for the post
post.titleReturns the post title
post.urlReturns the front end URL (view) for the post
post.adminurlReturns the admin edit link for the post
post.modifiedReturns the post modified date
post.dateReturns the post (original) date
post.typeReturns the post type.

Uses the “return” modifier to optionally return the post type label.
post.slugReturns the post slug
post.statusReturns the post status.

Uses the “return” modifier to optionally return the post status label.
psot.contentReturns the text content (body) of a post
post.commentcountReturns the number of comments on a post

Post parameters requiring Advanced Custom Fields #

ParameterDescription
post.acfReturns the value of an advanced custom field on the post.

Uses the “return” modifier to optionally return the field value as a human readable label. Works for SELECT fields and other field types that have both a value and a label

Uses the type modifier to determine if the returned values should be handled as text (default), date or a phone number

Uses the format modifier to optionally format the returned value as a specific date format (using php date() function syntax) or as a E.164 phone number

User parameters #

User parameters become available whenever the trigger that starts the workflow provides a User object.

ParameterDescription
user.idReturns the numeric user id for the user
user.nicknameReturns the user nickname
user.firstnameReturns the users first name
user.lastnameReturns the users last name
user.loginReturns the user login name
user.roleReturns the user (primary) role.

Uses the “return” modifier to optionally return the user role label.
user.emailReturns the user email address

Comment parameters #

Comment parameters become available whenever the trigger that starts the workflow provides a Comment object.

ParameterDescription
comment.idReturns the numeric comment id for the comment
comment.authoremailReturns the comment author email address
comment.authornameReturns the comment author name
comment.statusReturns the comment status
comment.typeReturns the comment type. Note that some plugins (WooCommerce) uses comments for things like order notes etc.
comment.contentReturns the content of the comment

Order parameters (WooCommerce) #

Order parameters become available whenever the trigger that starts the workflow provides a (WooCommerce) order object.

Base order parameters #

ParameterDescription
order.idReturns the numeric order id
order.dateReturns the order creation date
order.paiddateReturns the date when the order was paid
order.statusReturns the order status
order.emailReturns the email address of the customer
order.paymentmethodReturns the payment method used for the order.

Uses the “return” modifier to optionally return the payment method label.
order.stripe_feeOrder Stripe fee
order.paypal_feeOrder PayPal fee
order.totalReturns the order total amount
order.subtotalOrder subtotal
order.total_excl_taxOrder total excluding tax
order.total_taxThe total order tax
order.shipping_totalTotal order shipping
order.shipping_taxOrder shipping tax
order.discount_totalTotal order discount
order.discount_total_taxTotal order discount tax
order.feesAll fees on order (paid by customer)
order.fees_taxTax for all fees on order (paid by customer)
order.shippingmethodShipping method name
order.shippingzoneShipping zone name

Billing order parameters #

ParameterDescription
billing.full_nameBilling first name and last name joined together
billing.first_nameBilling first name
billing.last_nameBilling last name
billing.address_1Billing address line 1
billing.address_2Billing address line 2
billing.companyBilling company (where applicable)
billing.cityBilling city
billing.postcodeBilling post code
billing.stateBilling state (where applicable)
billing.countryBilling country
billing.phoneBilling phone number
billing.emailBilling email address

Shipping order parameters #

ParameterDescription
billing.full_nameShipping first name and last name joined together
billing.first_nameShipping first name
billing.last_nameShipping last name
billing.address_1Shipping address line 1
billing.address_2Shipping address line 2
billing.companyShipping company (where applicable)
billing.cityShipping city
billing.postcodeShipping post code
billing.stateShipping state (where applicable)
billing.countryShipping country

WordPress parameters #

ParameterDescription
datetimeReturns the current date and time when the workflow is executed.

Uses the format modifier to optionally format the returned value as a specific date format (using php date() function syntax)
site.urlReturns the site base URL
site.nameReturns the site nae
customfieldReturns a named custom field (meta data) of the object that triggered the workflow.

Uses the ‘name’ modifier to indicate which meta data field to return.

Uses the type modifier to determine if the returned values should be handled as text (default), date or a phone number

Uses the format modifier to optionally format the returned value as a specific date format (using php date() function syntax) or as a E.164 phone number
referer.urlReturns the URL of the referring page. If the request that initiates the workflow is a form, this parameter contains the URL of the page the form was shown on.
referer.postidIf the referring page can be translated back to a post object (page, post, order etc), this parameter returns that post id.

Special functionality parameters #

WooCommerce coupons #

The createcoupon parameter generates a unique WooCommerce coupon when it’s used. The use case is that when a WunderAutomation workflow sends an email or SMS to a customer, a unique coupon can be created and included in the sent message. This is primarily used in various marketing automation setups where some customer behaviour can be rewarded.

Confirmation links #

The confirmation link parameter creates a unique link that can be sent out in an email or SMS to an end user. When the end user receives and clicks the link, it is used to trigger another workflow. One common use case for confirmation links is to be able to ask an end user to confirm an email address or phone number. Another common use case is to ask the site administrator confirm a new user, a new post or a WooCommerce order by clicking a link.

Powered by BetterDocs

Leave a Reply

Your email address will not be published. Required fields are marked *