Overview
There are many Webhook Integration Service Providers available. Exercise caution when searching for a reputable provider. Some of them may claim they are and some require a specific Payload Format like Slack. In those cases, you need a Conversion Method that will take the Blox Custom JSON Payload and convert it so it can be accepted on their End Point URL. Zapier is a recommendable option to handle this Conversion Method.
So the way this works, log into your Zapier account and set up a Webhook using the Zapier instructions (see below).
Once done, in Zapier, you'll want to associate your other 3rd party account (ie: Slack) using their parameters.
Note: You may want to sign up for a Paid Account with Zapier because the Free Account only allows up to 100 messages which is good for testing purposes.
Here are some Implementation Examples for a few that are available:
Implementation Examples
The following are setup instructions for various Webhook Integration Service Providers. They are listed to give you an idea of how they may vary in the setup process. Once you're set up, all BLOX CMS needs is the Endpoint URL. In some cases, you may need to provide the Provider with a Secret (Unique ID) that is automatically generated by BLOXCMS when you set up a new Webhook. In order to create a Webhook, you must Have an account with a Service Integration Provider.
Note: Some of these providers do charge to set up an account, some do not. These listed are not an endorsement by TownNews.com.
Aha - Website
Log into or Register for this Webhook Integration Service Provider. Once the account is set up, do the following:
All API access is over HTTPS. HTTP requests will be redirected to HTTPS. The API should be accessed using the account specific domain yourcompany.aha.io. If the account specific domain cannot be used, then the API can be accessed via secure.aha.io and the account part of the domain should be specified in the X-AHA-ACCOUNT header (e.g. X-AHA-ACCOUNT: yourcompany).
Enter the Endpoint URL into your BloxCMS Webhook. For help with all of Aha! Service Integration Framework, Click Here.
Atlassian (Jira, Confluence, HipChat, Bitbucket, SourceTree) - Website
Log into or Register for this Webhook Integration Service Provider. The following Properties are required on the Atlassian side:
- Authentication
- Base URL
- Key
- Enter the Endpoint URL into BloxCMS (e.g. http://www.example.com/connect/jira).
Connect My Apps - Website
Log into or Register for this Webhook Integration Service Provider. Once the account is set up, do the following:
Note: If you sign up for a Free Trial for this Provider, know that it is a 14-Day Trial Period and billing automatically begins on the day after expiration.
X-Formation Connect - Website
Log into or Register for this Webhook Integration Service Provider. You will need to enable the Google Domain API Access if you want to set up a Gmail Webhook. To do so, do the following:
- Sign into the Google Admin Console.
- From the Dashboard, go to Security / API Reference.
- Check Enable API Access.
- Click Save Changes.
- More Google API Admin information
Zapier Webhook Setup - Website
Note: Zapier provides additional Services and/or Applications for other Providers, including many that require a Custom Formatted Payload to their End Point URL.
Log into or Register for this Webhook Integration Service Provider. Once the account is set up, do the following:
- Click on Make a Zap.
- Enter Webhook in the Search field.
- Select Webhooks by Zapier Trigger.
- Select Catch Hook then click on Save and Continue.
Skip the part that says "Pick Off a Child Key" for now . If you want, you can come back to this later and consider customizing this (ie: only reacting to new articles in the news/local section, etc.).
- Select Continue to the next screen.
- Get the End Point URL from Zapier under where it says "Use This."
- In BloxCMS Admin, go to Settings / Webhooks and then click on New.
- Enter the Zapier End Point URL into BloxCMS.
- Select the Event(s) for this Webhook and then click on Save.
- When done, return to Zapier and do the following:
- Click "OK I Did This." This will allow Zapier to verify the Webhook.
Then it will say, "Looking For The Hook."
Note: At this point you have to Trigger The Event(s) that it is waiting for (ie: Create a New Article or Login With a New User, etc.).
- Wait a few seconds. It can take several seconds, even up to a minute but it will say "Test Successful" when it completes.
- Click "Continue."
- This takes you to the "Choose An Action App" (also considered another Integration Provider (ie: Slack).
- Select an Action App (there are several to choose from).
- Select an App Action (ie: Send Channel Message).
- Scroll down and click on Save and Continue.
- This takes you to "Select AppName Account." If you don't have one, click on Create New Account.
- Clicking on Connect a New Account opens another window.
- Enter your Team Domain Name (ie: TownNews).
- Click Continue.
- Enter your Email Address and Password and click Sign In (required in order to see the page).
Note: If you can't get signed in when Creating a New Account for the Action App you selected, its' best to go to their site and set up an account there. Email confirmations from the Action App Site may go to your Spam box instead of your Inbox.
- Once the New Account is set up, click on Save and Continue.
- Now its' goling to ask you to pick a Channel Message and enter the Text Message (both required). There are several options to choose from as well.
- Once you're done, click on Continue at the bottom of the page. Review all the options as some have default settings that will be added unless you specify otherwise.
- The next page confirms your selections. Click on Continue. This will run a Test and display the results.
- Next, you can add another Step or click on Finish.
- Enter a Name for your Zap and you can opt to turn it on.
- Next you have a choice to See It On Your Dashboard or Make a New Zap.
- Now you can log in and manage your Zaps (Webhooks).
If you have a provider that requires a Custom Formatted Payload to their End Point URL, set up their Service or Application in Zapier and enter in their parameters so your Webhook can be accepted on their End Point URL.
- Now, set up the other side of the Webhook. In Zapier, select a Service (e.g. Google Docs, Email, Slack, etc.).
- Use the Wizard in Zapier to Map out a Webhook that will record data and notify your remote service.
- Finish the Setup in Zapier. This will cause the Events that will trigger Registered Events.
- Any Fired Event should trigger your Zapier Setup. Unregistered Events will do nothing.
Zendesk - Website
Log into or Register for this Webhook Integration Service Provider. The Endpoint URL that you'll use will depend on the type of API you use to setup your Webhook.