Post parameters
Post parameters become available whenever the trigger that starts the workflow provides a post object.
Parameter | Description |
---|---|
post.id | Returns the numeric post ID for the post. |
post.title | Returns the post title. |
post.url | Returns the front-end URL (view) for the post. |
post.adminurl | Returns the admin edit link for the post. |
post.modified | Returns the post modified date. |
post.date | Returns the post (original) date. |
post.type | Returns the post type. Uses the "return" modifier to optionally return the post type label. |
post.slug | Returns the post slug. |
post.status | Returns the post status. Uses the "return" modifier to optionally return the post status label. |
post.content | Returns the text content (body) of a post. |
post.commentcount | Returns the number of comments on a post. |
Post parameters requiring Advanced Custom Fields
Parameter | Description |
---|---|
post.acf | Returns 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 phone number. Uses the format modifier to optionally format the returned value as a specific date format (using PHP date() function syntax) or as an E.164 phone number. |
User parameters
User parameters become available whenever the trigger that starts the workflow provides a user object.
Parameter | Description |
---|---|
user.id | Returns the numeric user ID for the user. |
user.nickname | Returns the user’s nickname. |
user.firstname | Returns the user’s first name. |
user.lastname | Returns the user’s last name. |
user.login | Returns the user’s login name. |
user.role | Returns the user’s (primary) role. Uses the "return" modifier to optionally return the user’s role label. |
user.email | Returns the user’s email address. |
Comment parameters
Comment parameters become available whenever the trigger that starts the workflow provides a comment object.
Parameter | Description |
---|---|
comment.id | Returns the numeric comment ID for the comment. |
comment.authoremail | Returns the comment author email address. |
comment.authorname | Returns the comment author name. |
comment.status | Returns the comment status. |
comment.type | Returns the comment type. Note that some plugins (WooCommerce) use comments for things like order notes etc. |
comment.content | Returns 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
Parameter | Description |
---|---|
order.id | Returns the numeric order ID. |
order.date | Returns the order creation date. |
order.paiddate | Returns the date when the order was paid. |
order.status | Returns the order status. |
order.email | Returns the email address of the customer. |
order.paymentmethod | Returns the payment method used for the order. Uses the "return" modifier to optionally return the payment method label. |
order.stripe_fee | Order Stripe fee. |
order.paypal_fee | Order PayPal fee. |
order.total | Returns the order total amount. |
order.subtotal | Order subtotal. |
order.total_excl_tax | Order total excluding tax. |
order.total_tax | Total order tax. |
order.shipping_total | Total order shipping. |
order.shipping_tax | Order shipping tax. |
order.discount_total | Total order discount. |
order.discount_total_tax | Total order discount tax. |
order.fees | All fees on order (paid by customer). |
order.fees_tax | Tax for all fees on order (paid by customer). |
order.shippingmethod | Shipping method name. |
order.shippingzone | Shipping zone name. |
Billing order parameters
Parameter | Description |
---|---|
billing.full_name | Billing first name and last name joined together. |
billing.first_name | Billing first name. |
billing.last_name | Billing last name. |
billing.address_1 | Billing address line 1. |
billing.address_2 | Billing address line 2. |
billing.company | Billing company (where applicable). |
billing.city | Billing city. |
billing.postcode | Billing postcode. |
billing.state | Billing state (where applicable). |
billing.country | Billing country. |
billing.phone | Billing phone number. |
billing.email | Billing email address. |
Shipping order parameters
Parameter | Description |
---|---|
billing.full_name | Shipping first name and last name joined together. |
billing.first_name | Shipping first name. |
billing.last_name | Shipping last name. |
billing.address_1 | Shipping address line 1. |
billing.address_2 | Shipping address line 2. |
billing.company | Shipping company (where applicable). |
billing.city | Shipping city. |
billing.postcode | Shipping postcode. |
billing.state | Shipping state (where applicable). |
billing.country | Shipping country. |
WordPress parameters
Parameter | Description |
---|---|
datetime | Returns 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_url | Returns the site base URL. |
site_name | Returns the site name. |
customfield | Returns a named custom field (metadata) of the object that triggered the workflow. Uses the ‘name’ modifier to indicate which metadata 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 an E.164 phone number. |
referer_url | Returns 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_postid | If 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’s 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 to confirm a new user, a new post, or a WooCommerce order by clicking a link.