Engage Webhooks

#Overview

You can use webhooks in Engage to automatically send data back to your WP Fusion powered WordPress site.

Using webhooks, you can import new users on your WordPress site based on changes in Engage, or update existing users’ meta data and tags.

Having trouble receiving webhooks? Check out our troubleshooting guide.

#Setup

In Engage, create a new automation, and select a trigger. In this case we are triggering the automation when a subscriber’s email address changes.

Add a new action, and from the dropdown, choose Call webhook.

Set the Webhook URL following the examples below.

#Webhook URL parameters

You can format your webhook URL in a few different ways to customize the behavior. For each you will need to supply your access key, which can be obtained from the bottom of the main settings panel in your WP Fusion settings.

#To update a user’s tags

To update an existing WordPress user’s tags from the contact record, the URL for the webhook should look like the following:

https://mydomain.com/?wpf_action=update_tags&access_key=YOURACCESSKEY

#To update a user’s tags and meta data

To update a user’s tags and pull any new meta data from Engage for that contact, the URL for the webhook should look like the following:

https://mydomain.com/?wpf_action=update&access_key=YOURACCESSKEY

#Create a new user

To create a new user, use the following URL:

https://mydomain.com/?wpf_action=add&access_key=YOURACCESSKEY

You can also specify additional parameters in user creation. For example, to send the user a welcome email containing a link to log in on your site, use the following:

https://mydomain.com/?wpf_action=add&access_key=YOURACCESSKEY&send_notification=true

You can also specify a specific user role to be assigned to the new user. For example, to set the new user to the “customer” role, use the following:

https://mydomain.com/?wpf_action=add&access_key=YOURACCESSKEY&role=customer

Note that you have to have registered a “customer” role on your site for this to work. By default users will be assigned the role of “subscriber”.

The add method will update a user if an existing user already exists. It will not create a duplicate user.

Note: By default, user accounts will be created with their email address as the username and a randomly generated password. However, if you have created a custom username field and password field in Engage , and enabled these fields in WP Fusion for sync with user_login and user_pass on your website, the new users will be given the usernames and passwords stored in their Engage contact record.

#User passwords

New user accounts will be created with an automatically generated password. If you’d like to use this password in your email marketing, you can send the password back to Engage after it has been generated.

In the Webhooks section of the General settings tab, check the box for Return Password, and select a field in Engage where the password should be stored.

After a new user is created, their automatically generated password will now be saved back to their contact record, and you can use a merge field to include it in an email. The username will be the contact’s email address.

Was this helpful?