What are Webhooks?
Webhooks are automated messages or signals sent from one application to another when a specific event occurs. They allow real-time data communication between different systems without the need for constant manual polling or checking. Think of them as doorbells: when someone pushes a doorbell button (an event), it rings inside the house (a signal to another system), letting the homeowner know there's someone at the door.
How does the outgoing Webhooks work in HeadQ?
Event Trigger: Within HeadQ platform, various events can be set to trigger an outgoing webhook. This could be anything from a new order created, a contact updated, or lead deleted.
Webhook Configuration: To set up a webhook, you'll provide the URL of the application or system you want to send data to. This is called the "Endpoint URL."
Payload: Once the event is triggered, our system packages the relevant data into a structured format, in JSON. This package is known as the "payload." and it contains information on what event is in question, which entity it is about and what is the current state of the entity.
Data Transmission: The payload is then sent via an HTTP POST request to the specified endpoint URL.
Receiving Application's Response: After the receiving system gets the payload, it will should send back a response to acknowledge the receipt. Our system will then consider the webhook delivered if the response is successful.
Benefits of using outgoing Webhooks
Real-time Updates: With webhooks, your connected applications can receive real-time updates, ensuring that your data is always current and synced.
Automate Workflows: By integrating with other tools and platforms, you can automate workflows, such as sending notifications to your team chat when a task is completed.
Reduce Server Load: Instead of constantly polling our API for updates, which can be resource-intensive, you can sit back and wait for events to happen.
Setting up outgoing Webhooks in HeadQ
- Navigate to the 'Integrations' under the 'Settings' section.
- Find the 'Webhooks' list and click on 'Add a new webhook.'
Webhook management
- Provide the Endpoint URL where you want to send the data.
- Give an optional description for the purpose.
- Choose the events you want to trigger the webhook.
- Save the changes
If you want to edit Webhook later (ie. adding new event types), you can click three dots and select edit.
How to confirm that everything works?
HeadQ provides "Show events" view that allows you to see most recent 30 events sent and their status. You can confirm that integration works if you get an 'OK' status with your calls. You can also send test events and re-sent requests.
