Action - Send Webhook
The Send Webhook action step allows you to send a webhook from Encharge to another service when a person reaches a certain point in the Flow.
Note that the tool you're sending the Webhook to must be able to receive Webhooks. For instance, Encharge supports receiving Webhooks through the Receive Webhook trigger step. Also, note that some tools support sending Webhooks but do not have a feature for receiving Webhooks.
How Send Webhook works?
The Send Webhook action sends a webhook to an external service or tool when a person reaches a certain point in your Flow.
To do that you must obtain a Webhook URL from the external tool, and paste it into the Send Webhook step in Encharge.
Then, each time a person enters the Send Webhook step, Encharge will send the person's data (i.e., default fields and custom fields) to the Webhook URL. Then, the external tool will receive that data. Note that you must specify which fields you want to send to the external tool.
Some tools can also send a response back, which you can map to data/fields in Encharge.
How to set up Send Webhook step?
Copy the Webhook URL from the tool that you want to send data to and paste it in the URL field.
Each tool has a different user interface for Webhooks. To find out the Webhook URL, consult the documentation of the tool.
- Select the Method. If you're unsure about this, use POST (the method selected by default).
- Select the Content Type (optional). The content type tells how to format the data. Applies only when the method is POST, PUT, or PATCH. If unsure, use 'JSON'.
Enter the Webhook Data. This step is critical as it defines what data (i.e., person fields/properties) to send to the Webhook. In other words, it tells what data the external tool will receive from Encharge. If you leave this empty, Encharge will send an empty Webhook with no data.
Start by clicking on "+ Add property". A new property placeholder will be created:
The left field (Property Name) is the name of the property/field in the external tool – it needs to match exactly the name of the field you're sending data to.
The right field (Property Value) is the value you're sending from Encharge. Here you can use merge tags and Liquid tags to send dynamic data. For example, if you'd like to send the name of the person, you can use
In the example below we're sending the first name and the email of the people that enter the step to fields called "First name" and "Email" respectively:
- Add Headers (optional)
- Save the step
Next, you will be asked to perform a test run on a person from your Encharge account. Enter their email or name and click on Send test
If the Webhook was sent successfully, the external tool should receive the data. In our example, that would be the name and the email of the person.
Depending on the tool, you might also receive a response back from the tool. Encharge allows you to map the data from the response to fields in Encharge.
If no response is sent from the external tool, you will see an empty screen.
In both cases, click on Save to finalize the setup of the Send Webhook step.