Pluga Webhooks: How to create automated workflows with apps not integrated to Pluga

Do you want to create an automated workflow here at Pluga, but the app you want to integrate isn't available in our hub yet? Don't worry! Pluga Webhooks can help you! 😊

In this article we will explain:

• What a Webhook is
• How Pluga Webhooks work
• How to create an automated workflow via Pluga Webhooks

 

What is a webhook?

Imagine the following scenario: you want to send a message to a friend and decide to do it via SMS!

• You already know the message you want to send;
• You know which friend you want to send it to;
• And you know which mobile phone number you want to forward the SMS to.

Once these specifics are clear, communication between you and your friend will be successful. 🕺

This logic remains the same when we talk about webhooks!

Only instead of friends, it's the apps that send messages to each other. The mobile phone number corresponds to the URL that should receive the information, and the method of communication itself (SMS) would correspond to the Webhook.

Integration via webhooks allows messages to be sent, and actions executed, through a URL generated by the app that receives the data and performs the commands.

(Back to top ⬆)

How does Pluga Webhooks work?

Pluga Webhooks is an alternative that allows you to create automated workflows with apps not yet integrated to Pluga.

Keep in mind: At least one of the apps in your automated workflow must be integrated to Pluga!

This can happen in two ways:

[1] When you want to capture information from an app not yet integrated

In this case, the information will be sent to Pluga (through the webhook), we will process it and send it to one of the apps in our hub. See in the image below:

[1] When you want to send information to an app not yet integrated

In this other scenario, we will capture the information from one of the apps in our hub, process it, and send it to the app that is not integrated to Pluga.

So, for your integration via Pluga Webhooks to work as expected, the app you want to integrate meets needs to meet some requirements:

• Allow integration via webhooks;

• Have JSON fields.

Don't know what JSON is? Learn more here!

JSON is the format information needs to be in when sent through Pluga automations. So, you will need it to create automated workflows! Usually JSON looks something like this:

{
“name”:”Yoda”,
“country”:”lala”
“position”:”Jedi Master”
“e-mail”:”[e-mail]”
}

Each app has its own JSON and sometimes it can end up being a bit large and complex. But with a little dedication, you can easily find it and create your automated workflow here at Pluga!

Tip: You can check with the support team of the non-integrated app if they already have an example of a JSON for these cases of integration via webhook.

(Back to top ⬆)

How to create an automated workflow via Pluga Webhooks?

If you have come this far, you have realized that creating an automated workflow with Pluga Webhooks is no big deal. 🚫👾

Now, you need to decide if you want to:

• Capture information from an app not yet integrated;
• Send information to a non-integrated app.

With that in mind, just follow the tutorials below.

How to set up Pluga Webhooks to capture information from an app that hasn’t been integrated yet

Follow the steps below to create an automated workflow with Pluga Webhooks as the source of the data:

You have to:

1. Generate and copy Pluga's URL;
2. Paste it into the non-integrated app (data source app);
3. Set up the automation trigger of the non-integrated app (the trigger is the action that activates an event for Pluga, for example, a newly approved payment);
4. *Paste the JSON with the information that the app will return to Pluga;
5. Carry out the mapping at Pluga and finish the automation.

*Don't have the JSON? We might have the answer! 😊

You might get a little lost in step 4 - especially if you don't find the JSON in the app you’re trying to integrate.

In general, the app itself can help you (either through its documentation or support), but if you have come this far and still don't have the JSON, Pluga's support team might be able to help.

But for that, you need to set up the webhook correctly in your source app, paste the Pluga URL there, finish the automation, and send a test notification.

This way we will receive the information that you need to properly set up the automation in the JSON format.

Then, just contact our support team through the live chat or by emailing [e-mail] with your automation ID and we will send you the JSON. After that, just access your mapping again and update the JSON!

(Back to top ⬆)

How to set up Pluga Webhooks to send information to a non-integrated app

Follow the steps below to set up Pluga Webhooks as the target of the data:

In this case, you need to:

1. Generate an URL within the app that should receive information from Pluga (the non-integrated app);
2. If necessary, set up the webhook within the app, indicating which action you want executed;
3. Paste the generated URL into your Pluga automation;
4. *Assemble the mapping based on the JSON expected by the target app;
5. Finish the automation and start sending the information!

*In Step 4, it is essential that you assemble the mapping by filling out the “Key” field with the correct information expected by the app, usually indicated with a JSON example.

That way, the app will understand exactly what it is receiving from Pluga.

For example, if the target app calls the “customer name” field “name”, then this “name” is what should be filled out in the automation mapping.

Still in the example above, if you had written "customer name" as the Key, the target app would not understand this notation and would not be able to perform an action for you.

Therefore, the JSON model is very important here. :)

(Back to top ⬆)

Still have questions?

If you still have questions, just create a support ticket and our team will get in touch as soon as possible.