Connect Formidable Forms to Easy Digital Downloads
All integration endpoints
Get started
Requirements
To take advantage of these integrations, please make sure the following plugins/services are installed and activated.
Documentation
To make sure you have everything you need, we prepared some neat links for you that assure a smooth start of using WP Webhooks.
Use cases
Formidable Forms, renew a license via Easy Digital Downloads. Formidable Forms, delete a discount via Easy Digital Downloads. Formidable Forms, create a license via Easy Digital Downloads. Formidable Forms, delete a subscription via Easy Digital Downloads. Formidable Forms, update a payment via Easy Digital Downloads. Formidable Forms, delete a payment via Easy Digital Downloads. Formidable Forms, update a discount via Easy Digital Downloads. Formidable Forms, update a license via Easy Digital Downloads. Formidable Forms, create a license via Easy Digital Downloads. Formidable Forms, delete a download via Easy Digital Downloads. Formidable Forms, delete a license via Easy Digital Downloads. Formidable Forms, create a discount via Easy Digital Downloads. Formidable Forms, delete a payment via Easy Digital Downloads. Formidable Forms, delete a subscription via Easy Digital Downloads. Formidable Forms, create a payment via Easy Digital Downloads. Formidable Forms, delete a customer via Easy Digital Downloads. Formidable Forms, update a customer via Easy Digital Downloads. Formidable Forms, update a download via Easy Digital Downloads. Formidable Forms, update a subscription via Easy Digital Downloads. Formidable Forms, renew a license via Easy Digital Downloads. Formidable Forms, create a subscription via Easy Digital Downloads.More info
Formidable Forms
Formidable Forms is a WordPress plugin allowing users to create custom forms and surveys on their websites. It includes a drag-and-drop form builder, support for multiple field types, and options for customizing the appearance of forms. The plugin also includes integrations with popular email marketing and payment gateway services, making it a powerful tool for collecting and managing customer information and payments on a WordPress website.
Easy Digital Downloads
Easy Digital Downloads is a WordPress plugin that allows users to sell digital products on their WordPress website. It includes automatic inventory tracking, support for multiple payment gateways, and detailed reporting. The plugin suits many businesses, including software companies, e-book authors, and online course creators. Its user-friendly interface and comprehensive feature set make it famous for selling digital products on WordPress websites.
Customer created
This webhook fires as soon as a new customer is created within Easy Digital Downloads.
Create customer
This webhook action allows you to create a customer within Easy Digital Downloads.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- customer_email
(String) The email of the customer you want to create. In case the user already exists, we do not update it.
- customer_first_name
(String) The first name of the customer.
- customer_last_name
(String) The last name of the customer.
- additional_emails
(String) A comma-separated list of additional email addresses. Please check the description for further details.
- attach_payments
(String) A comma-, and doublepoint-separated list of payment ids you want to assign to the user. Please check the description for further details.
- increase_purchase_count
(Integer) increase the purchase count for the customer.
- increase_lifetime_value
(Float) The price you want to add to the lifetime value of the customer. Please check the description for further details.
- set_primary_email
(String) The email you want to set as the new primary email. Default: customer_email
- customer_notes
(String) A JSON formatted string containing one or multiple customer notes. Please check the description for further details.
- customer_meta
(String) A JSON formatted string containing one or multiple customer meta data. Please check the description for further details.
- user_id
(Integer) The user id of the WordPress user you want to assign to the customer. Please read the description for further details.
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More infos are in the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
Customer updated
This webhook fires as soon as a customer is updated within Easy Digital Downloads.
Create discount
This webhook action allows you to create a dicsount code within Easy Digital Downloads.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- code
(String) The dicsount code you would like to set for this dicsount. Only alphanumeric characters are allowed.
- name
(String) The name to identify the discount code.
- status
(String) The status of the discount code. Default: active
- current_uses
(Integer) A number that tells how many times the coupon code has been already used.
- max_uses
(Integer) The number of how often the discount code can be used in total.
- amount
(Mixed) The amount of the discount code. If chosen percent, use an interger, for an amount, use float. More info is within the description.
- start_date
(String) The start date of the availability of the discount code. More info is within the description.
- expiration_date
(String) The end date of the availability of the discount code. More info is within the description.
- type
(String) The type of the discount code. Default: percent. More info is within the description.
- min_price
(Mixed) The minimum price that needs to be reached to use the discount code. More info is within the description.
- product_requirement
A comma-separated list of download IDs that are required to apply the discount code. More info is within the description.
- product_condition
(String) A string containing further conditions on when the discount code can be applied. More info is within the description.
- excluded_products
(String) A comma-separated list, containing all the products that are excluded from the discount code. More info is within the description.
- is_not_global
(String) Set this argument to "yes" if you do not want to apply the discount code globally to all products. Default: no. More info is within the description.
- is_single_use
(String) Set this argument to "yes" if you want to limit this discount code to only a single use per customer. Default: no. More info is within the description.
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More info is within the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
File downloaded
This webhook fires once a file download is initiated within Easy Digital Downloads.
Create download
This webhook action allows you to create a download within Easy Digital Downloads.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- price
(float) The price of the download you want to use. Format: 19.99
- is_variable_pricing
(string) Set this value to "yes" if you want to activate variable pricing for this product. Default: no
- variable_prices
(string) A JSON formatted string, containing all of the variable product prices. Please see the description for further details.
- default_price_id
(integer) The ID of the price variation you want to use as the default price.
- download_files
(String) A JSON formatted string containing all of the downloable file. Please see the description for further details.
- bundled_products
(String) A JSON formatted string, containing all of the bundled products. Please see the description for further details.
- bundled_products_conditions
(String) A JSON formatted string that contains the price dependencies. Please see the description for further details.
- increase_earnings
(Float) The price you would like to increase the lifetime earnings of this product. Please see the description for further details.
- decrease_earnings
(Float) The price you would like to decrease the lifetime earnings of this product. Please see the description for further details.
- increase_sales
(Integer) Increase the number of sales from a statistical point of view. Please see the description for further details.
- decrease_sales
(Integer) Decrease the number of sales from a statistical point of view. Please see the description for further details.
- hide_purchase_link
(String) Set this string to "yes" to hide the purchase button under the download. Please see the description for more details.
- download_limit
(Integer) Limits how often a customer can globally download the purchase. Please see the description for further details.
- download_author
(mixed) The ID or the email of the user who added the post. Default is the current user ID.
- download_date
(string) The date of the post. Default is the current time. Format: 2018-12-31 11:11:11
- download_date_gmt
(string) The date of the post in the GMT timezone. Default is the value of $post_date.
- download_content
(string) The post content. Default empty.
- download_content_filtered
(string) The filtered post content. Default empty.
- download_title
(string) The post title. Default empty.
- download_excerpt
(string) The post excerpt. Default empty.
- download_status
(string) The post status. Default 'draft'.
- comment_status
(string) Whether the post can accept comments. Accepts 'open' or 'closed'. Default is the value of 'default_comment_status' option.
- ping_status
(string) Whether the post can accept pings. Accepts 'open' or 'closed'. Default is the value of 'default_ping_status' option.
- download_password
(string) The password to access the post. Default empty.
- download_name
(string) The post name. Default is the sanitized post title when creating a new post.
- to_ping
(string) Space or carriage return-separated list of URLs to ping. Default empty.
- pinged
(string) Space or carriage return-separated list of URLs that have been pinged. Default empty.
- download_parent
(int) Set this for the post it belongs to, if any. Default 0.
- menu_order
(int) The order the post should be displayed in. Default 0.
- download_mime_type
(string) The mime type of the post. Default empty.
- guid
(string) Global Unique ID for referencing the post. Default empty.
- download_category
(string) A comma separated list of category names, slugs, or IDs. Defaults to value of the 'default_category' option. Example: cat_1,cat_2,cat_3
- tags_input
(string) A comma separated list of tag names, slugs, or IDs. Default empty.
- tax_input
(string) A simple or JSON formatted string containing existing taxonomy terms. Default empty. More details within the description.
- meta_input
(string) A json or a comma and semicolon separated list of post meta values keyed by their post meta key. Default empty. More info in the description.
- wp_error
Whether to return a WP_Error on failure. Posible values: "yes" or "no". Default value: "no".
- do_action
Advanced: Register a custom action after Webhooks Pro fires this webhook. More infos are in the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
Form submitted
This webhook fires as soon as a form is submitted within Formidable Forms.
Customizations
Down below you will find a list of possible customizations you have available within our plugin. You can use them to fire the trigger only on certain criterias.
- Trigger on selected forms
Select only the forms you want to fire the trigger on. You can also choose multiple ones. If none is selected, all are triggered.
- Submission by field IDs
By default, Formidable returns the submission fields with generic keys. This doesn not matter when all fields are sent over, but in some cases, empty fields are not submitted, causing the order to shift. To avoid that, activate this setting and we turn the generic index into the form field ID, making sure you always address the same field.
Create license
This webhook action allows you to create a license within Easy Digital Downloads - Software Licensing.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- download_id
(Integer) The id of the download you want to associate with the license. Please see the description for further details.
- payment_id
(Integer) The id of the payment you want to associate with the license. Please see the description for further details.
- price_id
(String) In case you work with multiple pricing options (variations) within the same product, please set the pricing id here. Please see the description for further details.
- cart_index
(Integer) The numerical index in the cart items array of the product the license key is associated with. Please see the description for further details.
- existing_license_ids
(String) A JSON formatted string of existing license ids. Please see the description for further information.
- parent_license_id
(Integer) Set the parent id of this license in case you want to use this license as a child license. Please see the description for further details.
- activation_limit
(Integer) A number representing the amount of possible activations at the same time. set it to 0 for unlimited activations. Please see the description for further details.
- license_length
(Integer) The length of the license key.
- expiration_date
(String) In case you want to customize the expiration date, you can define the date here. Otherwise it will be calculated based on the added product. Please see the description for further details.
- is_lifetime
(String) Set this value to "yes" to mark the license as a lifetime license. Default: no
- manage_sites
(String) A JSON formatted string containing one or multiple site urls. Please see the description for further details.
- logs
(String) A JSON formatted string containing one or multiple logs. Please see the description for further details.
- license_meta
(String) A JSON formatted string containing one or multiple meta values. Please see the description for further details.
- license_action
(String) Do additional, native actions using the license. Please see the description for further details.
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More info is within the description.
- license_meta_arr
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
License activated
This webhook fires on activation of a license within Easy Digital Downloads.
Create payment
This webhook action allows you to create a payment within Easy Digital Downloads.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- customer_email
(String) The email of the customer you want to associate with the payment. Please see the description for further details.
- discounts
(String) A comma-separated list of discount codes. Please see the description for further details.
- gateway
(String) The slug of the currently used gateway. Please see the description for further details. Default empty.
- currency
(String) The currency code of the payment. Default is your default currency. Please see the description for further details.
- parent_payment_id
(Integer) The payment id of a parent payment.
- payment_status
(String) The status of the payment. Default is "pending". Please see the description for further details.
- product_data
(String) A JSON formatted string, containing all the product data and options. Please refer to the description for examples and further details.
- edd_agree_to_terms
(String) Defines if a user agreed to the terms. Set it to "yes" to mark the user as agreed. Default: no
- edd_agree_to_privacy_policy
(String) Defines if a user agreed to the privacy policy. Set it to "yes" to mark the user as agreed. Default: no
- payment_date
(String) Set a custom payment date. The format is flexible, but we recommend SQL format.
- user_id
(Integer) The user id of the WordPress user. If not defined, we try to fetch the id using the customer_email.
- customer_first_name
(String) The first name of the customer. Please see the description for further details.
- customer_last_name
(String) The last name of the customer. Please see the description for further details.
- customer_country
(String) The country code of the customer.
- customer_state
(String) The state of the customer.
- customer_zip
(String) The zip of the customer.
- send_receipt
(String) Set it to "yes" for sending out a receipt to the customer. Default "no". Please see the description for further details.
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More infos are in the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
License created
This webhook fires on creation of a license within Easy Digital Downloads.
Create subscription
This webhook action allows you to create a subscription within Easy Digital Downloads - Recurring.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- expiration_date
(String) The date for the expiration of the subscription. Recommended format: 2021-05-25 11:11:11
- profile_id
(String) This is the unique ID of the subscription in the merchant processor, such as PayPal or Stripe.
- download_id
(Integer) The ID of the download you want to connect with the subscription.
- customer_email
(String) The email of the customer. Please see the description for further details.
- period
(String) The billing period of the subscription. Please see the description for further details.
- initial_amount
(Mixed) The amount for the initial payment. E.g. 39.97
- recurring_amount
(Mixed) The recurring amount for the subscription. E.g. 19.97
- transaction_id
(String) This is the unique ID of the initial transaction inside of the merchant processor, such as PayPal or Stripe.
- status
(String) The status of the given subscription. Please see the description for further details.
- created_date
(String) The date of creation of the subscription. Recommended format: 2021-05-25 11:11:11
- bill_times
(Integer) This refers to the number of times the subscription will be billed before being marked as Completed and payments stopped. Enter 0 if payments continue indefinitely.
- parent_payment_id
(Integer) Use this argument to connect the subscription with an already existing payment. Otherwise, a new one is created. Please see the description for further details.
- customer_id
(Integer) The id of the customer you want to connect. If it is not given, we try to fetch the user from the customer_email argument. Please see the description for further details.
- customer_first_name
(String) The first name of the customer. Please see the description for further details.
- customer_last_name
(String) The last name of the customer. Please see the description for further details.
- edd_price_option
(Integer) The variation id for a download price option. Please see the description for further details.
- gateway
(String) The gateway you want to use for your subscription (and maybe payment). Please see the description for further details.
- initial_tax_rate
(Integer) The percentage for your initial tax rate. Please see the description for further details.
- initial_tax
(Float) The amount of tax for your initial tax amount. Please see the description for further details.
- recurring_tax_rate
(Integer) The percentage for your recurring tax rate. Please see the description for further details.
- recurring_tax
(Float) The amount of tax for your recurring tax amount. Please see the description for further details.
- notes
(String) A JSON formatted string containing one or multiple subscription notes. Please check the description for further details.
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More info is within the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
License deactivated
This webhook fires on deactivation of a license within Easy Digital Downloads.
Delete customer
This webhook action allows you to delete a customer within Easy Digital Downloads.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- customer_value
(String) The actual value you want to use to determine the customer. In case you havent set the get_customer_by argument or you set it to email, place the customer email in here.
- get_customer_by
(String) The type of value you want to use to fetch the customer from the database. Possible values: email, customer_id, user_id. Default: email
- delete_records
Set this argument to "yes" if you want to delete all of the customer records (payments) from the database. More info is within the description.
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More info is within the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
License status updated
This webhook fires on certain status changes of licenses within Easy Digital Downloads.
Customizations
Down below you will find a list of possible customizations you have available within our plugin. You can use them to fire the trigger only on certain criterias.
- Trigger on selected license status changes
Select only the license statuses you want to fire the trigger on. You can choose multiple ones. If none is selected, all are triggered.
Delete discount
This webhook action allows you to delete a dicsount code within Easy Digital Downloads.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- discount_id
(Mixed) The dicsount ID or discount code of the discount you want to delete.
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More info is within the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
Payments status changed
This webhook fires on certain status changes of payments within Easy Digital Downloads.
Customizations
Down below you will find a list of possible customizations you have available within our plugin. You can use them to fire the trigger only on certain criterias.
- Trigger on selected payment status changes
Select only the payment statuses you want to fire the trigger on. You can choose multiple ones. If none is selected, all are triggered.
Delete download
This webhook action allows you to delete (or trash) a download within Easy Digital Downloads.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- download_id
The download id of the download you want to delete.
- force_delete
(optional) Whether to bypass trash and force deletion. Possible values: "yes" and "no". Default: "no".
- do_action
Advanced: Register a custom action after Webhooks Pro fires this webhook. More infos are in the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
Stripe Payment Completed
This webhook fires as soon as a Stripe payment was completed within Formidable Forms.
Delete license
This webhook action allows you to delete a license within Easy Digital Downloads - Software Licensing.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- license_id
(Mixed) The license id or the license key of the license you would like to delete. Please see the description for further details.
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More info is within the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
Subscription payment created
This webhook fires as soon as a new subscription payment is created within Easy Digital Downloads.
Delete payment
This webhook action allows you to delete a payment within Easy Digital Downloads.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- payment_id
(Integer) The id of the payment you want to update.
- update_customer_stats
(String) Set this value to "yes" to update the statistics of the customer. Default: no
- delete_download_logs
(String) Set this value to "yes" to delete the payment including all its related download logs. Default: no
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More infos are in the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
Subscription status changed
This webhook fires on certain status changes of subscriptions within Easy Digital Downloads.
Customizations
Down below you will find a list of possible customizations you have available within our plugin. You can use them to fire the trigger only on certain criterias.
- Trigger on selected subscription status changes
Select only the subscription statuses you want to fire the trigger on. You can choose multiple ones. If none is selected, all are triggered.
Delete subscription
This webhook action allows you to delete a subscription within Easy Digital Downloads - Recurring.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- subscription_id
(Integer) The id of the subscription you would like to delete.
- keep_payment_meta
(String) Set this value to "yes" if you do not want to delet the relation of the subscription on the related payment. Default: no
- keep_list_of_trials
(String) Set this value to "yes" to delete the list of trials of the user that are related to the given subscription id. Default: no
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More info is within the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
Renew license
This webhook action allows you to renew a license within Easy Digital Downloads - Software Licensing.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- license_id
(Mixed) The license id or the license key of the license you would like to renew. Please see the description for further details.
- payment_id
(Integer) The payment id of the payment you want to use to process the renewal.
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More info is within the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
Update customer
This webhook action allows you to update (and create) a customer within Easy Digital Downloads.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- customer_value
(String) The actual value you want to use to determine the customer. In case you havent set the get_customer_by argument or you set it to email, place the customer email in here.
- get_customer_by
(String) The type of value you want to use to fetch the customer from the database. Possible values: email, customer_id, user_id. Default: email
- customer_email
(String) The primary email of the customer you want to update. In case the user does not exists, we use this email to create it (If you have set the argument create_if_none to yes).
- customer_first_name
(String) The first name of the customer.
- customer_last_name
(String) The last name of the customer.
- additional_emails
(String) A comma-separated list of additional email addresses. Please check the description for further details.
- attach_payments
(String) A comma-, and doublepoint-separated list of payment ids you want to assign to the user. Please check the description for further details.
- increase_purchase_count
(Integer) increase the purchase count for the customer.
- increase_lifetime_value
(Float) The price you want to add to the lifetime value of the customer. Please check the description for further details.
- set_primary_email
(String) The email you want to set as the new primary email. Default: customer_email
- customer_notes
(String) A JSON formatted string containing one or multiple customer notes. Please check the description for further details.
- customer_meta
(String) A JSON formatted string containing one or multiple customer meta data. Please check the description for further details.
- user_id
(Integer) The user id of the WordPress user you want to assign to the customer. Please read the description for further details.
- create_if_none
Set this argument to "yes" if you want to create the customer in case it does not exist.
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More infos are in the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
Update discount
This webhook action allows you to update (or create) a dicsount code within Easy Digital Downloads.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- discount_id
(Mixed) The discount ID or the discount code of the discount you would like to update.
- create_if_none
(String) Set this value to "yes" in case the given discount does not exist and you want to create it. Default: no
- code
(String) The dicsount code you would like to set for this dicsount. Only alphanumeric characters are allowed.
- name
(String) The name to identify the discount code.
- status
(String) The status of the discount code.
- current_uses
(Integer) A number that tells how many times the coupon code has been already used.
- max_uses
(Integer) The number of how often the discount code can be used in total.
- amount
(Mixed) The amount of the discount code. If chosen percent, use an interger, for an amount, use float. More info is within the description.
- start_date
(String) The start date of the availability of the discount code. More info is within the description.
- expiration_date
(String) The end date of the availability of the discount code. More info is within the description.
- type
(String) The type of the discount code. Default: percent. More info is within the description.
- min_price
(Mixed) The minimum price that needs to be reached to use the discount code. More info is within the description.
- product_requirement
A comma-separated list of download IDs that are required to apply the discount code. More info is within the description.
- product_condition
(String) A string containing further conditions on when the discount code can be applied. More info is within the description.
- excluded_products
(String) A comma-separated list, containing all the products that are excluded from the discount code. More info is within the description.
- is_not_global
(String) Set this argument to "yes" if you do not want to apply the discount code globally to all products. Default: no. More info is within the description.
- is_single_use
(String) Set this argument to "yes" if you want to limit this discount code to only a single use per customer. Default: no. More info is within the description.
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More info is within the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
Update download
This webhook action allows you to update (or create) a download within Easy Digital Downloads.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- download_id
(Integer) The ID of the existing download
- create_if_none
(String) Set this value to "yes" to create the download in case the given download id does not exist. Default: no
- price
(float) The price of the download you want to use. Format: 19.99
- is_variable_pricing
(string) Set this value to "yes" if you want to activate variable pricing for this product. Default: no
- variable_prices
(string) A JSON formatted string, containing all of the variable product prices. Please see the description for further details.
- default_price_id
(integer) The ID of the price variation you want to use as the default price.
- download_files
(String) A JSON formatted string containing all of the downloable file. Please see the description for further details.
- bundled_products
(String) A JSON formatted string, containing all of the bundled products. Please see the description for further details.
- bundled_products_conditions
(String) A JSON formatted string that contains the price dependencies. Please see the description for further details.
- increase_earnings
(Float) The price you would like to increase the lifetime earnings of this product. Please see the description for further details.
- decrease_earnings
(Float) The price you would like to decrease the lifetime earnings of this product. Please see the description for further details.
- increase_sales
(Integer) Increase the number of sales from a statistical point of view. Please see the description for further details.
- decrease_sales
(Integer) Decrease the number of sales from a statistical point of view. Please see the description for further details.
- hide_purchase_link
(String) Set this string to "yes" to hide the purchase button under the download. Please see the description for more details.
- download_limit
(Integer) Limits how often a customer can globally download the purchase. Please see the description for further details.
- download_author
(mixed) The ID or the email of the user who added the post. Default is the current user ID.
- download_date
(string) The date of the post. Default is the current time. Format: 2018-12-31 11:11:11
- download_date_gmt
(string) The date of the post in the GMT timezone. Default is the value of $post_date.
- download_content
(string) The post content. Default empty.
- download_content_filtered
(string) The filtered post content. Default empty.
- download_title
(string) The post title. Default empty.
- download_excerpt
(string) The post excerpt. Default empty.
- download_status
(string) The post status. Default 'draft'.
- comment_status
(string) Whether the post can accept comments. Accepts 'open' or 'closed'. Default is the value of 'default_comment_status' option.
- ping_status
(string) Whether the post can accept pings. Accepts 'open' or 'closed'. Default is the value of 'default_ping_status' option.
- download_password
(string) The password to access the post. Default empty.
- download_name
(string) The post name. Default is the sanitized post title when creating a new post.
- to_ping
(string) Space or carriage return-separated list of URLs to ping. Default empty.
- pinged
(string) Space or carriage return-separated list of URLs that have been pinged. Default empty.
- download_parent
(int) Set this for the post it belongs to, if any. Default 0.
- menu_order
(int) The order the post should be displayed in. Default 0.
- download_mime_type
(string) The mime type of the post. Default empty.
- guid
(string) Global Unique ID for referencing the post. Default empty.
- download_category
(string) A comma separated list of category names, slugs, or IDs. Defaults to value of the 'default_category' option. Example: cat_1,cat_2,cat_3
- tags_input
(string) A comma separated list of tag names, slugs, or IDs. Default empty.
- tax_input
(string) A simple or JSON formatted string containing existing taxonomy terms. Default empty. More details within the description.
- meta_input
(string) A json or a comma and semicolon separated list of post meta values keyed by their post meta key. Default empty. More info in the description.
- wp_error
Whether to return a WP_Error on failure. Posible values: "yes" or "no". Default value: "no".
- do_action
Advanced: Register a custom action after Webhooks Pro fires this webhook. More infos are in the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
Update license
This webhook action allows you to update a license within Easy Digital Downloads - Software Licensing.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- license_id
(Mixed) The license id or the license key of the license you would like to update. Please see the description for further details.
- download_id
(Integer) The id of the download you want to associate with the license. Please see the description for further details.
- payment_id
(Integer) The id of the payment you want to associate with the license. Please see the description for further details.
- license_key
(String) A new license key for the susbcription. Please see the description for further details.
- price_id
(String) In case you work with multiple pricing options (variations) within the same product, please set the pricing id here. Please see the description for further details.
- cart_index
(Integer) The numerical index in the cart items array of the product the license key is associated with. Please see the description for further details.
- status
(String) The status of the given license. Please see the description for further details.
- parent_license_id
(Integer) Set the parent id of this license in case you want to use this license as a child license. Please see the description for further details.
- activation_limit
(Integer) A number representing the amount of possible activations at the same time. set it to 0 for unlimited activations. Please see the description for further details.
- date_created
(String) In case you want to customize the creation date, you can define the date here. Please see the description for further details.
- expiration_date
(String) In case you want to customize the expiration date, you can define the date here. Otherwise it will be calculated based on the added product. Please see the description for further details.
- manage_sites
(String) A JSON formatted string containing one or multiple site urls. Please see the description for further details.
- logs
(String) A JSON formatted string containing one or multiple logs. Please see the description for further details.
- license_meta
(String) A JSON formatted string containing one or multiple meta values. Please see the description for further details.
- license_action
(String) Do additional, native actions using the license. Please see the description for further details.
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More info is within the description.
- license_meta_arr
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
Update payment
This webhook action allows you to update a payment within Easy Digital Downloads.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- payment_id
(Integer) The id of the payment you want to update.
- payment_status
(String) The status of the payment. Please see the description for further details.
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More infos are in the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
Update subscription
This webhook action allows you to update a subscription within Easy Digital Downloads - Recurring.
Arguments
Down below you will find a list of all available arguments you can use for this specific endpoint. Each of those arguments can be set within the webhook request.
- subscription_id
(Integer) The id of the subscription you would like to update.
- expiration_date
(String) The date for the expiration of the subscription. Recommended format: 2021-05-25 11:11:11
- profile_id
(String) This is the unique ID of the subscription in the merchant processor, such as PayPal or Stripe.
- download_id
(Integer) The ID of the download you want to connect with the subscription.
- customer_email
(String) The email of the customer in case you do not have the customer id. Please see the description for further details.
- period
(String) The billing period of the subscription. Please see the description for further details.
- initial_amount
(Mixed) The amount for the initial payment. E.g. 39.97
- recurring_amount
(Mixed) The recurring amount for the subscription. E.g. 19.97
- transaction_id
(String) This is the unique ID of the initial transaction inside of the merchant processor, such as PayPal or Stripe.
- status
(String) The status of the given subscription. Please see the description for further details.
- created_date
(String) The date of creation of the subscription. Recommended format: 2021-05-25 11:11:11
- bill_times
(Integer) This refers to the number of times the subscription will be billed before being marked as Completed and payments stopped. Enter 0 if payments continue indefinitely.
- parent_payment_id
(Integer) Use this argument to connect the subscription with an already existing payment. Please see the description for further details.
- customer_id
(Integer) The id of the customer you want to connect. If it is not given, we try to fetch the user from the customer_email argument. Please see the description for further details.
- edd_price_option
(Integer) The variation id for a download price option. Please see the description for further details.
- initial_tax_rate
(Integer) The percentage for your initial tax rate. Please see the description for further details.
- initial_tax
(Float) The amount of tax for your initial tax amount. Please see the description for further details.
- recurring_tax_rate
(Integer) The percentage for your recurring tax rate. Please see the description for further details.
- recurring_tax
(Float) The amount of tax for your recurring tax amount. Please see the description for further details.
- notes
(String) A JSON formatted string containing one or multiple subscription notes. Please check the description for further details.
- do_action
Advanced: Register a custom action after WP Webhooks fires this webhook. More info is within the description.
- wpwh_call_action
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )