Webhooks Now Available
Webhook are one of those things where if you have to ask what they are, you probably don’t need to worry about ’em. :)
But if you’re looking for Webhooks for the purpose of e.g. integrating CoachAccountable with some other system, we’ve now got you covered on this front!
A Webhook is essentially you giving marching orders to CoachAccountable along the lines of “Hey, anytime _____ happens in my account, please send data about that event to this other place on the web (so that I can have an automated process listening for when that happens and take whatever appropriate action in response)”.
From your Settings >> API Access >> Webhooks area you’ll be able to define one or more Webhooks.
When you create/define a webhook, you give it a name (whatever is handy for your own reference), and the URL to which CA should post data about the event.
Ostensibly scary and technical, turns out there’s not too much to it!
Beyond that, you can add any authorization and custom headers that will be expected on the receiving URL.
Once those key bits are set, you can choose which events you’d like CoachAccountable to send to that URL. Check or uncheck whichever are relevant for your purposes (i.e. which events you’d like to “subscribe” to), and you’re set!
You can easily test your Webhook to see:
- the exact format of data that CA will send for each type of event, and
- what CA gets when it posts that data to your URL (with whatever headers)
Do this by clicking the “Test this Webhook URL…” link, as found towards the bottom of that Webhook editor pop up:
Choose the type of event you’re interested from that pop up.
Upon hitting “Send test”, CA will pack up that data and POST it to the URL of choice, and you’ll see the result (i.e. the response that CA got back) immediately.
All green? You can be pretty assured things are set as they need to be:
See red? Chances are you’ll have to adjust something on one end or the other:
And that’s all there is to it! You can create as many Webhooks as you need, and have CA report whichever event types to each respective URL set by a Webhook. These can double up, too, in that you can have more than one Webhook listening for the same event.
You can see the full lowdown on Webhooks here in the CoachAccountable Knowledge Base.
For this initial release a fair number of in-app events are supported, but certainly there are more that could be. If you need others, just ask!
