UserEngage Webhooks

Overview

You can use webhooks in UserEngage to send data back to your WordPress site using WP Fusion. Using webhooks you can create new users on your WordPress site based on rules in UserEngage, or update existing users’ meta data and tags.

Having trouble receiving webhooks? Check out our troubleshooting guide.

Getting started

Go to the Automations page under the Engage menu in the sidebar and create a new rule. Select a trigger for the rule, such as when a page is visited, a field is modified, or a tag is applied. In the screenshot below we’ve configured the rule to be triggered whenever the “Add User to WP” tag is applied.

You can also specify any conditions you’d like to be met, or leave this section blank.

 


Under “Actions”, choose “API Call” from the dropdown menu. Enter the URL to your site following the examples in the next sections. You can get your site’s unique access key from the bottom of the main WP Fusion settings page.

 

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:

http://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 UserEngage for that contact, the URL for the webhook should look like the following:

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

Create a new user

To create a new user, use the following URL:

http://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:

http://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:

http://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 your UserEngage application, 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 UserEngage 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 UserEngage 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 UserEngage 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.