Omnisend Webhooks

#Overview

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

You can use webhooks inside of an automation when you need to send data back to WordPress at specific times, or only under certain conditions. For example you could set up a webhook to generate a new WordPress user whenever a contact is subscribe to marketing.

To set this up go to the Automations page in your Omnisend account and create a new automation. Select a trigger for the workflow, such as when a contact is subscribe to marketing, or when a fields meets certain criteria. In the example below we’ve configured the workflow to be triggered whenever the contact is subscribe to marketing.

Add a new messages, and choose “Webhook”.

In the URL field, enter your site’s URL along with the access_key and wpf_action parameters. For example:
https://mydomain.com/?access_key=YOURACCESSKEY&wpf_action=add

You can find your site’s unique access key at the bottom of the main WP Fusion settings page, under the Webhooks section.

In the HEADERS, add the following keys and values:

• key: Accept | value: application/json
• key: Content-Type | value: application/json

In the BODY, add:
"email": "[[contact.email]]"

Now when the automation is triggered the contact will be added to WordPress as a new user. There are several options for structuring the webhook URL, as follows:

#Webhook URL structure

#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 Omnisend 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.

#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 Omnisend 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 Omnisend 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.