WP Ultimo Hooks and filters
WP Ultimo is made up of a whole load of functions and database queries. It has hooks and filters that will allow you to modify or add new code to existing functions. We created a list of these hooks and filters as a reference to help advanced users further customize their network. You can access the list from Github by clicking the link below. https://github.com/next-press/wp-ultimo-hooks-and-filters/blob/main/wp-ultimo.md
A First Look on Webhooks (v2)
ATTENTION: Note that this feature or article is for advanced users. A webhook is a way for an app or software like WP Ultimo to provide other applications with real-time information. A webhook delivers data or payloads to other applications as it happens, meaning you get data immediately. This is helpful should you need to integrate or pass certain data from WP Ultimo going to another CRM or system each time an event is triggered. For example, you need to send the user's name and email address to a mailing list each time a new user account is created. How to create a webhook To create a webhook, go to your network admin dashboard. Click on WP Ultimo > Webhooks > Add New Webhook. When creating a new webhook you will be asked for information like Name, URL, and Event. You can use any name you want for your webhook. The most important fields are the URL and Event. URL is the endpoint or the destination to which WP Ultimo will send the payload or data. This is the application that will receive the data. Zapier is the most common solution that user uses to make integration with 3rd party application easier. Without a platform like Zapier, you will need to manually create a custom function that will catch the data and process it. See this article on how to use WP Ultimo webhook with Zapier. In this article, we will be looking at the basic concept of how a webhook works and the events available in WP Ultimo. We will be using a 3rd party site called requestbin.com. This site will allow us to create an endpoint and catch the payload without doing any coding. Disclaimer: all it will do is show us that the data has been received. There will be no processing or any kind of action done to the payload. Go to requestbin.com and click Create Request Bin. After clicking that button, it will ask you to log in if you already have an account or sign up. If you already have an account it will lead you right to their dashboard. On their dashboard, you will immediately see the endpoint or URL you can use in creating your WP Ultimo webhook. Go ahead and copy the URL and go back to WP Ultimo. Place the endpoint on the URL field and select an event from the dropdown. In this example, we will be selecting Payment Received. This event is triggered whenever a user makes a payment. All the events available, their description, and payloads are listed at the bottom of the page. Click the Add New Webhook button to save the webhook. We can now send a test event to the endpoint for us to see if the webhook we created is working. We can do this by clicking Send Test Event under the webhook we created. This shows a confirmation window saying that the test was successful. Now if we go back to the Requestbin site we will see that the payload has been received containing some test data. This is the basic principle of how webhook and endpoints work. If you are to create a custom endpoint, you will need to create a custom function to process the data your receive from WP Ultimo.
Integrating WP Ultimo with Zapier
In one of the articles, we discussed Webhooks and how they can be used to integrate with 3rd party applications. Using webhooks is a bit complicated as it requires advanced knowledge in coding and catching payloads. Using Zapier is a way for you to get around that. Zapier has integration with over 5000+ apps which makes communication between different applications easier. You can create Triggers that will be set off when events happen on your network (eg an account is created and triggers the account_create event) or generate Actions on your network reacting to external events (eg create a new account membership in your WP Ultimo network). This is possible because WP Ultimo Zapier's triggers and actions are powered by the REST API. How to start First, search for WP Ultimo in the Zapier app list. Alternatively, you can click this link. Go to your dashboard and press the + Create Zap button on the left sidebar to set up a new Zap. You will be redirected to the Zap creation page. In the search box type "wp ultimo". Click to choose the Beta version option. After selecting our app, choose the available event: New WP Ultimo Event. Now we need to give Zapier access to your network. Clicking in Sign in will open a new window requiring the API credentials. Go to your network admin panel and navigate to WP Ultimo > Settings > API & Webhooks and look for the API Settings section. Select the Enable API option as it is required for this connection to work. Use the Copy to Clipboard icon on the API Key and API Secret fields and paste those values on the integration screen. On the URL field, put your network full URL, including the protocol (HTTP or HTTPS). Click the Yes, Continue button to move on to the next step. If everything works out, you should be greeted by your new connected account! Click to Continue to create a new trigger. How to create a new Trigger Now that your account is connected you can see available events. Let's choose the payment_received event for this tutorial. Once the event has been selected and you click to continue, a test step will appear. In this stage, Zapier will test if your Zap can fetch the specific payload to that event. In future events of the same type, information with this same structure will be sent. In our tutorial the test was completed successfully and returned the payload example information. This example information will be useful to guide us while creating actions. Your trigger is now created and ready to be connected to other applications. How to create Actions Actions use information from other triggers to create new entries in your network. In the creating an action step you will choose the WP Ultimo Beta and the option of Create Items on WP Ultimo. In the next step you will either create your authentication, just like we did in How to start, or select a created authentication. In this tutorial we will choose the same authentication previously created. Setting up the Action This is the main step of the action and here things are a little different. The first information you will choose is the Item. Item is the information model of your network such as Customers, Payments, Sites, Emails and others. When selecting an item, the form will rearrange to bring the required and optional fields for the selected item. For example, when selecting the item Customer, the form fields will bring everything that is necessary to fill in to create a new Customer in the network. After filling in all fields marked as required and clicking on continue, a last screen will show you the filled fields and the fields that were left unfilled. As soon as your test completes and is successful your action is configured. It is also important to check on your network if the item was created with the test of your action.
Event: Register an account via Zapier
In the article Integrating WP Ultimo with Zapier, we discussed how to use Zapier to perform different actions within WP Ultimo based on triggers and events. In this article, we will show how you can integrate 3rd party applications. We will use Google Sheets as the source of data and send the information to WP Ultimo to register an account. First, you need to create a Google Sheet under your Google Drive. Make sure you properly define each column so that you can easily map the data later. After creating a Google sheet, you can log in to your Zapier account and start creating a zap. Under the search field for "App event" select "Google Sheets" Then for the "Event" field select "New spreadsheet row" and hit "Continue" The next step will ask you to select a Google Account where the Google Sheet is saved. So just make sure that the right google account is specified. Under "Set up trigger", you will need to select and specify the google spreadsheet and worksheet you will use where the data will be coming from. Just go ahead and fill those out and hit "Continue" Next is to "test your trigger" to make sure that your google sheet is properly connected. If your test is successful, you should see the result showing some values from your spreadsheets. Click "Continue" to proceed. The next step is to set up the second action that will create or register an account in WP Ultimo. On the search field select "WP Ultimo(2.0.2)" Under the "Event" field, select "Register an Account in WP Ultimo" then click the "Continue" button. Under "Set up an action", you will see different fields available for customer data, memberships, products, etc. You can map the values under your google sheet and assign them to the proper field where they should be populated as shown in the screenshot below. After mapping the values, you can test the action.