We offer a Webhook automation as well as alternative version called Webhook (Raw). Webhook (Raw) is useful in situations where you need nesting in your JSON body. You can read more about Webhooks (Raw) here.
This article covers our standard Webhook automation which is generally easier to use and provides the additional benefit of allowing operators to review and tweak the JSON body.
Before we begin... this is one of our more complicated automations that requires a background understanding of webhooks, JSON and HTTP Post Requests. Although the process we have generated is straightforward, it will be easier if you have experience with these concepts before proceeding. If you need any help with this automation, feel free to contact us at email@example.com and one of our team members will walk you through it.
Function: The Webhook Automation allows you to build new integrations between Reflective and other apps using URL endpoints, headers and JSON request bodies.
Benefit: Webhooks allow you to integrate Reflective with apps we don't yet support, further personalizing and optimizing your workflow. The raw version, although less straightforward, allows for greater power and flexibility for the developer building it.
How does it work?
Start by selecting Webhook from the Action Item options.
Title: After selecting 'Webhook' from the Action Items, you can give your action item a title. By default this title is set to 'Webhook', but you may want to give it a more specific title so you can differentiate your Webhooks as you continue to build out your workflow.
Completion Mode: For more information on Completion Mode, see this article: Completion Mode.
Endpoint: Paste the URL Endpoint where you would like to send your post request. For example, if you wanted to add a Mailchimp Integration via the Webhook automation, you would paste the specific Mailchimp page URL where you want to send JSON data.
Our platform is able to detect if the URL endpoint is valid. If you input an invalid endpoint, you will get an error message.
Headers: In this section, include any key-value pairs that are HTTP headers. Check out the MDN Header Documentation if you need a reference.
Keys: List out the keys you would like for your JSON request. Use a comma to seperate each field.
Customize Webhook Action Item
Key Values: Each of the keys you listed in the previous step will now be presented as fields. You can map in previous form fields, specify hardcoded values or leave them blank. If you have selected "Human Touch" as the completion mode an operator will be able to review the values on each submission and make any necessary changes and/or additions.
Hit continue to move to the Review phase.
Review Action Item
In the Review phase, you will get a preview of the Request Body that will be sent to the URL Endpoint you included. If it looks good, hit 'Turn on Automation' to set your Webhook live and integrate with a new app.
Check out a few examples with one of our developers, Scott Windsor.