Webhooks
Whautomate provides a Webhook feature designed to facilitate real-time integration with external systems or services.
This feature empowers users to transmit data and notifications from Whautomate to other platforms, streamlining communication and automation processes.
General Use Cases
The list of webhook events is currently available for use. 👇
Clients
Client Created: Triggered when a new client is created
Client Tag Added: Triggered when a tag is added to the client
Client Tag Removed: Triggered when a tag is removed from the client
Contacts
Contact Created: Triggered when a new contact is created
Contact Tag Added: Triggered when a tag is added to the contact
Contact Tag Removed: Triggered when a tag is removed from the contact
Messages
WhatsApp, Instagram, Messenger, Telegram and Live Chat Incoming Messages: Triggered when a new message is received from the client.
WhatsApp, Instagram, Messenger, Telegram and Live Chat Outgoing Messages: Triggered when sending a new message to the client.
Appointments
Appointment Updates: Triggered when an appointment is booked, rescheduled, cancelled, etc by a client.
Classes
Class Participant Updates: Triggered when a class is booked, rescheduled, cancelled, etc by a client.
Invoices
Invoice Updates: Triggered when an invoice is created or the invoice status is updated as a draft, paid, pending, and sent.
Here are two methods to setup a webhook.
1. Setting Up a New Webhook
You can configure up to 5 webhooks, each capable of notifying your application about multiple selected events.
Note that this method does not offer a customized payload option; only HTTP POST requests are supported.
Step 1: Go to the Whautomate app, select the Integration menu option, and Select the Webhooks Connect button to continue.
Step 2: Select the New Webhook button to continue
Step 3: Configure Webhook Settings
(i) Enter the Webhook name Eg. Contact Created
(ii) Enter the Server URL where the webhook notifications will be sent.
(iii) Choose the events you want to receive notifications for. You can select multiple events for a single webhook. Eg. Contact Created
Step 4: Save your webhook configuration.
Test the webhook to ensure it is working correctly.
2. Setting Up a Customized Webhook with Payload Customization
This method allows you to send custom webhook payloads via RESTful endpoints, offering flexibility in data transfer and integration with external applications.
Step 1: Go to the Whautomate app, Select the Automation menu option, Click the Add Rule button, and then select the Create Rule From Scratch option to continue.
Step 2: Select the Trigger When a Client is created option.
Step 3: To add conditions, simply click on the "Add Condition" button.
Please set up the condition based on your specific use case. Note that I skipped the condition section in this case.
Step 4: Select a send Action type as the Webhooks by Whautomate option 👇
Add the Details of Webhook Configuration
(i) Select the Request Method option as POST
(ii) URL: Enter the URL where the webhook notifications will be sent.
(iii) Payload: The "Payload" refers to the data associated with the automation trigger. It includes the content or information transferred from Whautomate to the external system or service via the webhook. You can customise this payload according to your need.
Please enter (#) to choose from variables in the payload to be populated dynamically when customising the payload.
(iv) Headers: I used the Whautomate default header. If you want to use a new header, select the Add Header button and create. 👇
Step 5: To test the Webhook, please select the "Send Test Webhook" button.
Step 6: After filling in all the details Click the Save button. 👇
How to Test Webhooks Requests
Step 1: Go to the https://requestbin.com/ website, sign up for your account and then select the Create Request Bin button to continue which will give you enough credits for testing the webhooks.
Step 2: Copy the webhook request URL and Paste it into the Whautomate platform 👇
The Request URL is where Whautomate sends data and events. It's an external system that receives HTTP requests. Specify the URL of the receiving system for seamless data transmission and optimal performance.
Step 3: Go to the Whautomate app and paste the Request URL to the Create New Client Webhook Automation Action section URL field.
Note: Implement the automation trigger and conditions outlined in the upper section, which corresponds to those utilized in the Get Started
Step 5: To test the Webhook, please select the "Send Test Webhook" button.
Step 6: Go back to the Pipedream app and select the test event to check the test payload data.
Step 7: After filling in all the details Click the Save button. 👇
Here are the articles in this section:
ClientsContactsMessagesAppointmentsClassesInvoice UpdatesLast updated
