Connect Easy Digital Downloads to WordPress
Avaialble triggers & actions
Get started
Requirements
To use these integrations, please note that the following plugins/services are required:
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.
Example connections
Easy Digital Downloads, fire multiple webhooks within one request via WordPress. Easy Digital Downloads, delete a file via WordPress. Easy Digital Downloads, create an attachment from a base64 string via WordPress. Easy Digital Downloads, set custom taxonomy term meta data via WordPress. Easy Digital Downloads, create a file via WordPress. Easy Digital Downloads, update a taxonomy term via WordPress. Easy Digital Downloads, copy a file via WordPress. Easy Digital Downloads, send a remote HTTP request via WordPress. Easy Digital Downloads, install a plugin via WordPress. Easy Digital Downloads, delete a folder via WordPress. Easy Digital Downloads, create an attachment from a server path via WordPress. Easy Digital Downloads, update a comment via WordPress. Easy Digital Downloads, activate a plugin via WordPress. Easy Digital Downloads, get a user via WordPress. Easy Digital Downloads, fire custom PHP code via WordPress. Easy Digital Downloads, get or search for multiple users via WordPress. Easy Digital Downloads, install a plugin via WordPress. Easy Digital Downloads, delete a taxonomy term via WordPress. Easy Digital Downloads, call a PHP function via WordPress. Easy Digital Downloads, call a apply_filters hook via WordPress. Easy Digital Downloads, update a post via WordPress.Learn more
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.
WordPress
WordPress is a free, open-source platform to create websites and blogs. It is used on more than 64 million sites and continuously grows. WP Webhooks is made for WordPress and offers amazing features right out of the box to save you time and resources. It will extend the CMS by WordPress webhooks.
Create comment
Create a comment using webhooks.
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.
- comment_agent
(string) The HTTP user agent of the comment_author when the comment was submitted. Default empty.
- comment_approved
(int|string) Whether the comment has been approved. Default 1.
- comment_author
(string) The name of the author of the comment. Default empty.
- comment_author_email
(string) The email address of the $comment_author. Default empty.
- comment_author_IP
(string) The IP address of the $comment_author. Default empty.
- comment_author_url
(string) The URL address of the $comment_author. Default empty.
- comment_content
(string) The content of the comment. Default empty.
- comment_date
(string) The date the comment was submitted. To set the date manually, comment_date_gmt must also be specified. Default is the current time.
- comment_date_gmt
(string) The date the comment was submitted in the GMT timezone. Default is comment_date in the site's GMT timezone.
- comment_karma
(int) The karma of the comment. Default 0.
- comment_parent
(int) ID of this comment's parent, if any. Default 0.
- comment_post_ID
(int) ID of the post that relates to the comment, if any. Default 0.
- comment_type
(string) Comment type. Default empty.
- comment_meta
(array) Optional. Array of key/value pairs to be stored in commentmeta for the new comment. More info within the description.
- user_id
(int) ID of the user who submitted the comment. Default 0.
- do_action
Advanced: Register a custom action after this webhook was fired.
- 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 )
Comment deleted
This webhook fires after a comment was deleted.
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 post types
Select only the post types you want to fire the trigger on. You can also choose multiple ones. If none is selected, all are triggered.
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 )
Comment trashed
This webhook fires after a comment was trashed.
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 post types
Select only the post types you want to fire the trigger on. You can also choose multiple ones. If none is selected, all are triggered.
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 )
Comment updated
This webhook fires after a comment was updated.
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 post types
Select only the post types you want to fire the trigger on. You can also choose multiple ones. If none is selected, all are triggered.
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 )
Custom trigger called
This webhook fires after a custom trigger was called. For more information, please check the description.
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 )
Customer created
This webhook fires as soon as a new customer is created 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 )
Customer updated
This webhook fires as soon as a customer is updated within Easy Digital Downloads.
Create post
Insert/Create a post. You have all functionalities available from wp_insert_post
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.
- post_author
(mixed) The ID or the email of the user who added the post. Default is the current user ID.
- post_date
(string) The date of the post. Default is the current time. Format: 2018-12-31 11:11:11
- post_date_gmt
(string) The date of the post in the GMT timezone. Default is the value of $post_date.
- post_content
(string) The post content. Default empty.
- post_content_filtered
(string) The filtered post content. Default empty.
- post_title
(string) The post title. Default empty.
- post_excerpt
(string) The post excerpt. Default empty.
- post_status
(string) The post status. Default 'draft'.
- post_type
(string) The post type. Default 'post'.
- 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.
- post_password
(string) The password to access the post. Default empty.
- post_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.
- post_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.
- post_mime_type
(string) The mime type of the post. Default empty.
- guid
(string) Global Unique ID for referencing the post. Default empty.
- import_id
(integer) In case you want to give your post a specific post id, please define it here.
- post_category
(string) A comma separated list of category 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.
- meta_input
DEPRECATED! Please use manage_meta_data instead.
- meta_update
Update (or add) meta keys/values.
- manage_meta_data
In case you want to add more complex meta data, this field is for you. Check out some examples within our post meta blog post.
- acf_meta_update
Update (or add) Advanced Custom Fields meta keys/values.
- manage_acf_data
In case you want to add more complex Advanced Custom Fields data, this field is for you. Check out some examples within our post meta blog post.
- 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 the plugin fires this webhook.
- 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 )
Email sent
This webhook fires while an email is being sent from your WordPress site.
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 )
File downloaded
This webhook fires once a file download is initiated within Easy Digital Downloads.
Create user
Create a new user via webhooks.
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.
- user_email
This field is required. Include the email for the user.
- first_name
The first name of the user.
- last_name
The last name of the user.
- nickname
The nickname. Please note that the nickname will be sanitized by WordPress automatically.
- user_login
A string with which the user can log in to your site.
- display_name
The name that will be seen on the frontend of your site.
- user_nicename
A URL-friendly name. Default is user' username.
- description
A description for the user that will be available on the profile page.
- rich_editing
Wether the user should be able to use the Rich editor. Set it to "yes" or "no". Default "no".
- user_registered
The date the user gets registered. Date structure: Y-m-d H:i:s
- user_url
Include a website url.
- role
The main user role. If not set, default is subscriber.
- additional_roles
This allows to add multiple roles to a user.
- user_pass
The user password. If not defined, we generate a 32 character long password dynamically.
- user_meta
DEPRECATED! Please use manage_meta_data instead.
- meta_update
Update (or add) meta keys/values.
- manage_meta_data
In case you want to add more complex meta data, this field is for you. Check out some examples within our post meta blog post.
- acf_meta_update
Update (or add) Advanced Custom Fields meta keys/values.
- manage_acf_data
In case you want to add more complex Advanced Custom Fields data, this field is for you. Check out some examples within our post meta blog post.
- send_email
Set this field to "yes" to send a email to the user with the data.
- do_action
Advanced: Register a custom action after the plugin fires this webhook.
- 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.
Custom PHP action
Fire a custom PHP function within your WordPress website.
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.
- wpwh_identifier
This argument is sent over within the PHP code as seen in the example to diversify between the actions. You can use it to fire your customizations only on specific actions.
- 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.
Delete comment
Delete a comment using webhooks.
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.
- comment_id
(int) The comment id of the comment you want to delete.
- force_delete
(string) Wether you want to bypass the trash or not. You can set this value to "yes" or "no". Default "no"
- do_action
Advanced: Register a custom action after this webhook is executed.
- 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 )
Post created
This webhook fires after a new post was created.
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 post types
Select only the post types you want to fire the trigger on. You can also choose multiple ones. If none is selected, all are triggered.
- Trigger on post status
Fire the trigger on specific statuses only. If none is selected, all are triggered.
- Trigger on initial post status change
Select only the post status you want to fire the trigger on. You can also choose multiple ones. Important: This trigger only fires after the initial post status change. If you change the status after again, it doesn't fire anymore. We also need to set a post meta value in the database after you chose the post status functionality.
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 )
Post deleted
This webhook fires after a post was deleted.
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 post types
Select only the post types you want to fire the trigger on. You can also choose multiple ones. If none is selected, all are triggered.
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 )
Post trashed
This webhook fires after a post was trashed.
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 post types
Select only the post types you want to fire the trigger on. You can also choose multiple ones. If none is selected, all are triggered.
Delete post
Delete a post via WP Webhooks Pro.
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.
- post_id
The post id of your specified post. This field is required.
- force_delete
(optional) Whether to bypass trash and force deletion (added in WordPress 2.9). Possible values: "yes" and "no". Default: "no". Please note that soft deletion just works for the "post" and "page" post type.
- do_action
Advanced: Register a custom action after the plugin fires this webhook.
- 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 )
Post updated
This webhook fires after an existing post is updated.
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 post types
Select only the post types you want to fire the trigger on. You can also choose multiple ones. If none is selected, all are triggered.
- Trigger on post status
Fires as long as the post has one of your chosen post statuses. In case you want to add multiple once, please comma-separate them (e.g.: publish,draft). If none are set, all are triggered.
- Trigger on post status change
Fires once a post status changed to one of your chosen ones. Define specifc post statuses that you want to fire the trigger on. In case you want to add multiple once, please comma-separate them (e.g.: publish,draft). If none are set, all are triggered.
- Trigger on specific post IDs
Fires on the specified post IDs only. In case you want to add multiple once, please comma-separate them (e.g.: 123,456). If none are set, 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 )
Subscription payment created
This webhook fires as soon as a new subscription payment is created within Easy Digital Downloads.
Delete user
Deletes a user on your WordPress website or network.
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.
- user_id
(Optional if user_email is defined) Include the numeric id of the user.
- user_email
(Optional if user_email is defined) Include the assigned email of the user.
- send_email
Set this field to "yes" to send a email to the user that the account got deleted.
- remove_from_network
Set this field to "yes" to delete a user from the whole network. WARNING: This will delete all posts authored by the user. Default: "no"
- remove_from_subsites
Set the IDs of the subsite you want to remove the user from.
- do_action
Advanced: Register a custom action after the plugin fires this webhook.
- 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.
Get multiple posts
Search for posts on your WordPress website
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.
- arguments
A string containing a JSON construct in the WP_Query notation.
- return_only
Define the data you want to return. Please check the description for more information. Default: posts
- load_meta
Set this argument to "yes" to add the post meta to each given post. Default: "no"
- load_acf
Set this argument to "yes" to add the Advanced Custom Fields related post meta to each given post. Default: "no"
- load_taxonomies
Single value or comma separated list of the taxonomies you want to addto the response.
- do_action
Advanced: Register a custom action after the plugin fires this webhook.
- 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 )
User created
This webhook fires as soon as a user registers.
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.
- Send raw password
When set to true, we try to get the unhashed version of the password and send it along within the requests.
Get multiple users
Search for users on your WordPress website
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.
- arguments
A string containing a JSON construct in the WP_User_Query notation.
- return_only
Define the data you want to return. Please check the description for more information. Default: get_results
- do_action
Advanced: Register a custom action after the plugin fires this webhook.
- 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 )
User deleted
This webhook fires as soon as a user was deleted.
Get post
Returns the post/custom post from your given data.
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.
- post_value
The post id (default) of the post you want to fetch. See the Details for further information.
- value_type
Set this to either post_id or attachment_url, depending on your used post_value.
- return_only
Select the values you want to return. Default is all.
- thumbnail_size
Pass the size of the thumbnail of your given post id. Default is full.
- post_taxonomies
Single value or comma separated list of the taxonomies you want to return. Default: post_tag.
- do_action
Advanced: Register a custom action after our plugin fires this webhook.
- 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 )
User logged in
This webhook fires as soon as a user triggers the login.
Get user
Returns the object of a user
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.
- user_value
The user id of the user. You can also use certain other values by changing the value_type argument.
- value_type
You can choose between certain value types. Possible: id, slug, email, login
- do_action
Advanced: Register a custom action after the plugin fires this webhook.
- 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 )
User updated
This webhook fires as soon as a user updates his profile.
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 )
Hook apply_filters fired
This webhook fires after a specific apply_filters hook has been fired within WordPress.
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.
- Filter hook name
The action hook is the name of the apply_filters function. If the function is set to apply_filters( "this_is_my_action_hook", "this_is_my_callback", "some data" ), then this_is_my_action_hook is the name you use for the argument.
- Filter hook priority
The hook priority determines at which position the webhook should be triggered. If some other plugin or theme uses the hook with a higher priority (which means it will be executed later), then you can adjust this setting to match it to your requirements.
- Filter hook arguments
Adjust the amount of arguments that will be sent via this webhok action. For example, if the action call looks like this apply_filters( "this_is_my_action_hook", "this_is_my_callback", "First Argument", "Second Argument" ), then we will send back only the first argument. If you set this setting to 2, we will return both the first and the second argument.
Send email
This webhook action allows you to send an email from your WordPress site.
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.
- send_to
(string) Comma-separated list of email addresses you want to send the message to.
- subject
(string) Email subject
- message
(string) Message contents
- headers
(string) A JSON formatted string contaiing additional settings for the email such as CC, BCC, From etc. - Please see the description for further details.
- attachments
(string) A JSON formatted string contaiing attachments that should be added to the email. Please see the description for further information.
- do_action
Advanced: Register a custom action after the webhook fires.
- 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 )
Hook do_action fired
This webhook fires after a specific do_action hook has been fired within WordPress.
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.
- Action hook name
The action hook is the name of the do_action function. If the function is set to do_action( "this_is_my_action_hook", "this_is_my_callback", "some data" ), then this_is_my_action_hook is the name you use for the argument.
- Action hook priority
The hook priority determines at which position the webhook should be triggered. If some other plugin or theme uses the hook with a higher priority (which means it will be executed later), then you can adjust this setting to match it to your requirements.
- Action hook arguments
Adjust the amount of arguments that will be sent via this webhok action. For example, if the action call looks like this do_action( "this_is_my_action_hook", "this_is_my_callback", "First Argument", "Second Argument" ), then we will send back only the first argument. If you set this setting to 2, we will return both the first and the second argument.
Set taxonomy term meta
Create, update and delete taxonomy term meta via a webhook call.
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.
- taxonomy
(String) The slug of the taxonomy you want to update the items of.
- term_value
(Mixed) The identifier of the term value. This can be the term id, name or slug. If you want to change the value type, use the get_term_by argument. Default: term id
- manage_meta_data
(String) A JSON formatted string containing all of the term meta values you want to create/update/delete. Please see the description for further details.
- get_term_by
(String) An identifier on what term_value data you want to use to fetch the term. Default: term_id - 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 )
New site created
This webhook fires after a new site was created.
Set taxonomy terms
Set (and create) taxonomy terms on a post.
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.
- object_id
The object to relate to. (Post ID)
- taxonomy
The context in which to relate the term to the object. (Taxonomy slug)
- terms
The terms you want to set. Please see the description for more information.
- append
Please set this value to "yes" in case you want to append the taxonomies. If set to no, all previous entries to the defined taxonomies will be deleted. 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 )
Plugin activated
This webhook fires as soon as a plugin was activated.
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.
- Fire trigger on single or multisite.
In case you run a multisite network, select if you want to trigger the webhook on multisite activations, single site activations or both. If nothing is selected, both are triggered.
Test action
Test the functionality of this plugin by sending over a demo request.
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.
- test_var
A test var. Include the following value to get a success message back: test-value123
- 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 )
Plugin deactivated
This webhook fires as soon as a plugin was deactivated.
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.
- Fire trigger on single or multisite.
In case you run a multisite network, select if you want to trigger the webhook on multisite activations, single site activations or both. If nothing is selected, both are triggered.
Trash comment
Trash a comment using webhooks.
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.
- comment_id
(int) The comment id of the comment you want to trash.
- do_action
Advanced: Register a custom action after the action was fired.
- 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 )
Plugin deleted
This webhook fires as soon as a plugin was deleted.
Update comment
Updates a comment using webhooks.
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.
- comment_id
(string) The HTTP user agent of the comment_author when the comment was submitted. Default empty.
- comment_agent
(string) The HTTP user agent of the comment_author when the comment was submitted. Default empty.
- comment_approved
(int|string) Whether the comment has been approved. Default 1.
- comment_author
(string) The name of the author of the comment. Default empty.
- comment_author_email
(string) The email address of the $comment_author. Default empty.
- comment_author_IP
(string) The IP address of the $comment_author. Default empty.
- comment_author_url
(string) The URL address of the $comment_author. Default empty.
- comment_content
(string) The content of the comment. Default empty.
- comment_date
(string) The date the comment was submitted. To set the date manually, comment_date_gmt must also be specified. Default is the current time.
- comment_date_gmt
(string) The date the comment was submitted in the GMT timezone. Default is comment_date in the site's GMT timezone.
- comment_karma
(int) The karma of the comment. Default 0.
- comment_parent
(int) ID of this comment's parent, if any. Default 0.
- comment_post_ID
(int) ID of the post that relates to the comment, if any. Default 0.
- comment_type
(string) Comment type. Default empty.
- comment_meta
(array) Optional. Array of key/value pairs to be stored in commentmeta for the new comment. More info within the description.
- user_id
(int) ID of the user who submitted the comment. Default 0.
- do_action
Advanced: Register a custom action after the action was fired.
- 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 )
Shortcode called
This webhook fires as soon as the [wpwh_shortcode] shortcode was triggered.
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 )
Taxonomy term created
This webhook fires after a taxonomy term was created.
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 )
Taxonomy term deleted
This webhook fires after a taxonomy term was deleted.
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 )
Taxonomy term updated
This webhook fires after a taxonomy term was updated.
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 )
User logged out
This webhook fires after a user was logged out.
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 )
User password reset
This webhook fires after a user password was reset.
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 )
WordPress hook fired
This webhook fires once your selected WordPress hook (filter or action) has been called.
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.
- WordPress hook type
Select whether your defined hook is a filter or an action.
- WordPress hook name
Add the WordPress hook name that you want to use to fire this trigger on.
- WordPress hook priority
Add a custom WordPress hook priority. Default: 10
- WordPress hook arguments
Define the number of arguments this hook has. Default: 1
Activate plugin
This webhook action allows you to activate a plugin within your WordPress website.
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.
- plugin_slug
(string) The plugin slug of the plugin you want to activate. Please check the description for further details.
- do_action
Advanced: Register a custom action after WP Webhooks Pro fires this webhook. Please check the description for further details.
- 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 )
Call PHP function
Call a PHP function within WordPress.
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.
- function_name
(String) The function name of the PHP function you want to call.
- function_arguments
(String) The arguments you want to send over within the function call. Use the variable name as the key and the value for the variable value. JSON and serialized data will be converted to its original format. To avoid it, please wrap the value in double quotes.
- 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 )
Call apply_filters hook
Call a apply_filters hook within WordPress.
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.
- hook_name
(String) The apply_filters hook name of the hook you want to call.
- callback_arguments
(String) The arguments you want to send over within the callback. Use the variable name as the key and the value for the variable value. JSON and serialized data will be converted to its original format. To avoid it, please wrap the value in double quotes.
- 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 )
Copy file
Copy a local or remote file via a webhook inside of your WordPress folder structure.
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.
- source_path
The relative path of the file you want to copy. This can be a relative path or an external url. For example: wp-content/themes/demo-theme/demo-file.php or a full url like https://my-domain/image.jpg
- destination_path
The relative path as well as file name. For example: wp-content/uploads/demo-image.jpg (See the main description for more information)
- do_action
Advanced: Register a custom action after Webhooks Pro fires this webhook.
- 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 )
Copy folder
Copy a local folder via a webhook inside of your WordPress folder structure.
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.
- source_path
The relative path of the folder you want to copy. For example: wp-content/uploads/demo-folder
- destination_path
The relative path of the destination. For example: wp-content/uploads/new-folder (See the main description for more information)
- mode
The mode is 0777 by default, which means the widest possible access.
- recursive
Allows the creation of nested directories specified in the pathname. Possible values: "yes" and "no". Default: "no". If set to yes, all in your path mentioned folders will be created if they don't exist.
- do_action
Advanced: Register a custom action after this webhook was fired.
- 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 )
Create URL attachment
Create an attachment from an url on your website using webhooks.
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.
- url
The url of the file you want to create the attachment of.
- arguments
(JSON) Custom arguments to customize your upload process. Default: Please see the description for further information.
- file_name
Customize the file name of the attachment. - Please see the description for further information.
- parent_post_id
The parent post id in case you want to set a parent for the file. Default: 0
- add_post_thumbnail
Assign this attachment as a post thumbnail to one or multiple posts. Please see the description for further details.
- attachment_image_alt
Add a custom Alternative Text to the attachment (Image ALT).
- attachment_title
Add a custom title to the attachment (Image Title).
- attachment_caption
Add a custom caption to the attachment (Image Caption).
- attachment_description
Add a custom description to the attachment (Image Descripiton).
- 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 )
Create base64 attachment
Create an attachment from a base64 string using webhooks.
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.
- base64
The relative path of the file you want to create the attachment of. Please see the description for more information.
- parent_post_id
The parent post id in case you want to set a parent for it. Default: 0
- file_name
Customize the file name of the attachment. - Please see the description for further information.
- add_post_thumbnail
Assign this attachment as a post thumbnail to one or multiple posts. Please see the description for further details.
- attachment_image_alt
Add a custom Alternative Text to the attachment (Image ALT).
- attachment_title
Add a custom title to the attachment (Image Title).
- attachment_caption
Add a custom caption to the attachment (Image Caption).
- attachment_description
Add a custom description to the attachment (Image Descripiton).
- 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 )
Create file
Create a file via a webhook inside of your WordPress folder structure.
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.
- file
The path as well as the file name and extension. For example: wp-content/themes/demo-theme/index.php (See the main description for more information)
- content
The content for your file.
- mode
The mode of the file. Default "w" (Write)
- 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 )
Create folder
Create a folder via a webhook inside of your WordPress folder structure.
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.
- folder
The relative path as well as the folder name. For example: wp-content/themes/demo-theme/demo-folder (See the details for more information)
- mode
The mode is 0777 by default, which means the widest possible access.
- recursive
Allows the creation of nested directories specified in the pathname. Possible values: "yes" and "no". Default: "no". If set to yes, all in your path mentioned folders will be created if they don't exist.
- do_action
Advanced: Register a custom action after Webhooks Pro fires this webhook.
- 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 )
Create path attachment
Create an attachment from a local and relative path on your website using webhooks.
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.
- path
The relative path of the file you want to create the attachment of. Please see the description for more information.
- parent_post_id
The parent post id in case you want to set a parent for it. Default: 0
- file_name
Customize the file name of the attachment. - Please see the description for further information.
- add_post_thumbnail
Assign this attachment as a post thumbnail to one or multiple posts. Please see the description for further details.
- attachment_image_alt
Add a custom Alternative Text to the attachment (Image ALT).
- attachment_title
Add a custom title to the attachment (Image Title).
- attachment_caption
Add a custom caption to the attachment (Image Caption).
- attachment_description
Add a custom description to the attachment (Image Descripiton).
- 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 )
Create taxonomy term
Create a taxonomy term for a specific taxonomy.
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.
- term_name
(String) The name for the specific taxonomy term.
- taxonomy
(String) The slug of the taxonomy to relate the term with.
- alias_of
(String) Slug of the term to make this term an alias of. Default empty string. Accepts a term slug.
- description
(String) The term description. Default empty string.
- parent
(String) The id of the parent term. Default 0.
- slug
(String) The term slug to use. Default empty string.
- name
(String) The term name to use. Default empty string.
- 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 )
Deactivate plugin
This webhook action allows you to deactivate a plugin within your WordPress website.
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.
- plugin_slug
(string) The plugin slug of the plugin you want to deactivate. Please check the description for further details.
- do_action
Advanced: Register a custom action after WP Webhooks Pro fires this webhook. Please check the description for further details.
- 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 )
Delete attachment
Delete an attachment from your website using webhooks.
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.
- attachment_id
The id of the attachment you want to delete.
- force_delete
Whether to bypass trash and force deletion. Default: noPlease read the description for more information.
- 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 )
Delete file
Delete a file via a webhook inside of your WordPress folder structure.
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.
- file
The path as well as the file name and extension. For example: wp-content/themes/demo-theme/index.php
- do_action
Advanced: Register a custom action after Webhooks Pro fires this webhook.
- 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 )
Delete folder
Delete a folder and all of its sub folders and files via a webhook inside of your WordPress folder structure.
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.
- folder
The relative path as well as the folder name. For example: wp-content/themes/demo-theme/demo-folder (See the main description for more information)
- do_action
Advanced: Register a custom action after Webhooks Pro fires this webhook.
- 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 )
Delete taxonomy term
Delete a taxonomy term for a specific taxonomy.
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.
- term_id
(Integer) The ID of the taxonomy term you want to delete.
- taxonomy_slug
(String) The slug of the taxonomy to delete the term from.
- default_id
(Integer) The term ID to make the default term. This will only override the terms found if there is only one term found. Any other and the found terms are used.
- force_default
(String) Whether to force the supplied term as default to be assigned even if the object was not going to be term-less. Default: no
- 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 )
Fire do_action hook
Fire a do_action hook within WordPress.
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.
- hook_name
(String) The do_action hook name of the hook you want to call.
- callback_arguments
(String) The arguments you want to send over within the callback. Use the variable name as the key and the value for the variable value. JSON and serialized data will be converted to its original format. To avoid it, please wrap the value in double quotes.
- buffer_response
(String) Set this string to "yes" to capture the response of the action. This is specifically interesting if the action you want to call outputs content.
- 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 )
Fire multiple webhooks
Execute multiple webhooks within a single webhook call.
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.
- actions
This argument contains all of your executable webhook calls and settings.
- 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 )
Get taxonomy term
Get a single taxonomy term for all, or a specific taxonomy.
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.
- term_id
(Integer) The ID of the taxonomy term you want to get.
- taxonomy_slug
(String) The slug of the taxonomy to fetch the term from.
- 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 )
Get taxonomy terms
Get a one or multiple taxonomy terms for all, or a specific taxonomy.
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.
- arguments
(String) The JSON formatted data for the WP term query.
- 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 )
Install plugin
This webhook action allows you to install a plugin within your WordPress website.
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.
- plugin_slug
(string) The plugin slug of the plugin you want to install. Please check the description for further details.
- plugin_download
(String) The download URL of the plugin version you want to install. Please check the description for further details.
- do_action
Advanced: Register a custom action after WP Webhooks Pro fires this webhook. Please check the description for further details.
- 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 )
Manage WP post meta
Add, update, or delete custom post meta data within "WordPress".
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.
- post_id
The ID of the post you want to perform the action for.
- meta_update
Update (or add) meta keys/values.
- manage_meta_data
In case you want to add more complex meta data, this field is for you. Check out some examples within our post meta blog post.
- do_action
Advanced: Register a custom action after the plugin fires this webhook.
- 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 )
Manage WP user meta
Add, update, or delete custom user meta data within "WordPress".
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.
- user_id
The ID (or the email) of the user you want to perform the action for.
- meta_update
Update (or add) meta keys/values.
- manage_meta_data
In case you want to add more complex meta data, this field is for you. Check out some examples within our post meta blog post.
- do_action
Advanced: Register a custom action after the plugin fires this webhook.
- 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 )
Move file
Move a local file via a webhook inside of your WordPress folder structure.
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.
- source_path
The relative path of the file you want to move. For example: wp-content/uploads/demo-folder/demo-image.jpg
- destination_path
The relative path of the destination. For example: wp-content/uploads/new-folder/demo-file.jpg
- do_action
Advanced: Register a custom action after Webhooks Pro fires this webhook.
- 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 )
Move folder
Move a local folder via a webhook inside of your WordPress folder structure.
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.
- source_path
The relative path of the folder you want to move. For example: wp-content/uploads/demo-folder
- destination_path
The relative path of the destination. For example: wp-content/uploads/new-folder
- mode
The mode is 0777 by default, which means the widest possible access.
- recursive
Allows the creation of nested directories specified in the pathname. Possible values: "yes" and "no". Default: "no". If set to yes, all in your path mentioned folders will be created if they don't exist.
- do_action
Advanced: Register a custom action after Webhooks Pro fires this webhook.
- 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 )
Multisite assign user
Assign a user to one, multiple, or all blogs within a WordPress multisite.
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.
- user
The user email or ID of the user you want to assign to the specific sub sites.
- blog_ids
A comma-separated list of the IDs of the specific sub sites you want to assign the user to. Or "all" for all sub sites.
- role
The role you want to assign to the user. Default: The default role of your blog.
- do_action
Advanced: Register a custom action after the plugin fires this webhook.
- 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 )
Rename file or folder
Rename a local file or folder via a webhook inside of your WordPress folder structure.
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.
- source_path
The relative path of the folder you want to rename (and the file name and extension if you want to rename a file). For example: wp-content/themes/demo-theme/demo-folder or for a file wp-content/themes/demo-theme/demo-file.php
- destination_path
The relative path with the new folder name (or the new file name and extension if you want to rename a file). For example: wp-content/themes/demo-theme/new-demo-folder or for a file wp-content/themes/demo-theme/new-demo-file.php
- do_action
Advanced: Register a custom action after Webhooks Pro fires this webhook.
- 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 )
Send remote HTTP POST
This webhook action allows you to send a HTTP request from your WordPress site.
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.
- url
(string) A URL you want to send the data to. Our actions URLs are supported too.
- auth_template
Use a globally defined authentication template with this action.
- method
(string) The request type used to send the request.
- headers
(string) A JSON formatted string containing further header details.
- raw_body
(string) The raw body. If this argument is set, the "payload" argument is ignored.
- payload
(string) A JSON formatted string containing further payoad data.
- timeout
(integer) Filters the timeout value for an HTTP request. Default: 5
- redirection
(integer) Filters the number of redirects allowed during an HTTP request. Default 5
- httpversion
(string) Filters the version of the HTTP protocol used in a request. Default: 1.0
- user-agent
(string) Filters the user agent value sent with an HTTP request.
- blocking
(bool) Filter whether to wait for a response of the recipient or not. Default: true
- reject_unsafe_urls
(bool) Filters whether to pass URLs through wp_http_validate_url() in an HTTP request. Default: no
- sslverify
(string) Validates the senders SSL certificate before sending the data. Default: no
- limit_response_size
(integer) Limit the response size of the data coming back from the recpient. Default: null
- cookies
(string) A JSON formatted string containing additional cookie data.
- do_action
Advanced: Register a custom action after the webhook fires.
- 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 )
Uninstall plugin
This webhook action allows you to uninstall a plugin within your WordPress website.
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.
- plugin_slug
(string) The plugin slug of the plugin you want to uninstall. Please check the description for further details.
- force_delete
(String) Once you set this argument to "yes", it will delete the plugin as well in case it is active. Default "no".
- do_action
Advanced: Register a custom action after WP Webhooks Pro fires this webhook. Please check the description for further details.
- 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 plugin
This webhook action allows you to update a plugin within your WordPress website.
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.
- plugin_slug
(string) The plugin slug of the plugin you want to update. Please check the description for further details.
- do_action
Advanced: Register a custom action after WP Webhooks Pro fires this webhook. Please check the description for further details.
- 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 post
Update a post. You have all functionalities available from wp_update_post
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.
- post_id
(int) The post id itself. This field is mandatory
- post_author
(mixed) The ID or the email of the user who added the post. Default is the current user ID.
- post_date
(string) The date of the post. Default is the current time.
- post_date_gmt
(string) The date of the post in the GMT timezone. Default is the value of $post_date.
- post_content
(string) The post content. Default empty.
- post_content_filtered
(string) The filtered post content. Default empty.
- post_title
(string) The post title. Default empty.
- post_excerpt
(string) The post excerpt. Default empty.
- post_status
(string) The post status. Default 'draft'.
- post_type
(string) The post type. Default 'post'.
- 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.
- post_password
(string) The password to access the post. Default empty.
- post_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.
- post_modified
(string) The date when the post was last modified. Default is the current time.
- post_modified_gmt
(string) The date when the post was last modified in the GMT timezone. Default is the current time.
- post_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.
- post_mime_type
(string) The mime type of the post. Default empty.
- guid
(string) Global Unique ID for referencing the post. Default empty.
- post_category
(string) A comma separated list of category IDs. Defaults to value of the 'default_category' option. Example: cat_1,cat_2,cat_3. Please note that WordPress just accepts categories of the type "category" here.
- tags_input
(string) A comma separated list of tag names, slugs, or IDs. Default empty. Please note that WordPress just accepts tags of the type "post_tag" here.
- tax_input
(string) A simple or JSON formatted string containing existing taxonomy terms. Default empty.
- meta_input
DEPRECATED! Please use manage_meta_data instead.
- meta_update
Update (or add) meta keys/values.
- manage_meta_data
In case you want to add more complex meta data, this field is for you. Check out some examples within our post meta blog post.
- acf_meta_update
Update (or add) Advanced Custom Fields meta keys/values.
- manage_acf_data
In case you want to add more complex Advanced Custom Fields data, this field is for you. Check out some examples within our post meta blog post.
- wp_error
Whether to return a WP_Error on failure. Posible values: "yes" or "no". Default value: "no".
- create_if_none
Wether you want to create the post if it does not exists or not. Set it to "yes" or "no" Default is "no".
- do_action
Advanced: Register a custom action after the plugin fires this webhook.
- 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 taxonomy term
Update a taxonomy term for a specific taxonomy.
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.
- term_id
(String) The id for the taxonomy term you want to update.
- taxonomy
(String) The slug of the taxonomy to relate the term with.
- alias_of
(String) Slug of the term to make this term an alias of. Accepts a term slug.
- description
(String) The term description.
- parent
(String) The id of the parent term.
- slug
(String) The term slug to use.
- name
(String) The name you want to set for the term.
- 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 user
Update a user on your WordPress website or network.
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.
- user_id
(Optional if user_email or user_login is defined) Include the numeric id of the user. (Note that the user_id has a higher priority than the user_email.)
- user_email
(Optional if user_id or user_login is defined) Include the email correlated to the account.
- user_login
(Optional if user_email or user_id is defined) A string with which the user can log in to your site. This value can also be used ot update a user.
- first_name
The first name of the user.
- last_name
The last name of the user.
- nickname
The nickname. Please note that the nickname will be sanitized by WordPress automatically.
- display_name
The name that will be seen on the frontend of your site.
- user_nicename
A URL-friendly name. Default is user' username.
- description
A description for the user that will be available on the profile page.
- rich_editing
Wether the user should be able to use the Rich editor. Set it to "yes" or "no". Default "no".
- user_registered
The date the user got registered. Date structure: Y-m-d H:i:s
- user_url
Include a website url.
- role
The main user role. If set, all additional roles are removed.
- additional_roles
This allows to add/remove multiple roles on a user. For more information, please read the description.
- user_pass
The user password. If not defined, we don't generate a new one.
- user_meta
DEPRECATED! Please use manage_meta_data instead.
- meta_update
Update (or add) meta keys/values.
- manage_meta_data
In case you want to add more complex meta data, this field is for you. Check out some examples within our post meta blog post.
- acf_meta_update
Update (or add) Advanced Custom Fields meta keys/values.
- manage_acf_data
In case you want to add more complex Advanced Custom Fields data, this field is for you. Check out some examples within our post meta blog post.
- send_email
Set this field to "yes" to send a email to the user with the data.
- create_if_none
Wether you want to create the user if it does not exists or not. Set it to "yes" or "no" Default is "no".
- do_action
Advanced: Register a custom action after the plugin 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 )
Comment created
This webhook fires after a new comment was created.
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.
Select only the post types you want to fire the trigger on. You can also choose multiple ones. If none is selected, all are triggered.