How to use/create Webhook
The "Webhook" feature in Agency Handy allows users to set up automatic notifications and data transfers to other systems when specific events occur within the platform.
This integration is particularly useful for automating workflows, keeping systems synchronized, and triggering actions in external applications.
Pre-conditions
User Permissions: Ensure you have the necessary permissions to configure webhooks.
Endpoint URL: Obtain the URL of the external system where you want to send the webhook data. Endpoint URL should be a POST URL.
Content-Type: Determine the content type the external system requires (usually JSON).
Steps to Use
Log in to Your Account
Access your Agency Handy account using your credentials.
Navigate to Webhook Settings
From the Dashboard, Select “Integrations” => " Webhooks Management "
Authenticate
Click the “Management” button to authenticate the token..
Create a New Webhook
Click the “Create New Webhook” button to set up a new webhook.
Enter Endpoint URL
In the “Endpoint URL” field, enter the URL of the external system where you want to send the webhook data.
Select Content Type
Choose “JSON” as the content type for the webhook payload.
Select Webhook Events
Choose the specific events in Agency Handy that will trigger the webhook. These can include:
Service: Creation, Update, Deletion
Order: Creation, Update, Deletion
Task: Creation, Assigned, Completion, Update
Invoice: Status change
Client/User: New client added/created, Deletion
Proposal: Sent, Received, Accepted, Rejected
Ticket: Created, Assigned to, Status change
Payment: Received, Failed
Service Package: Creation, Update, Deletion
Configure Event Triggers
Identify and select key events within Agency Handy that will trigger the webhook. For example:
Service Events: When a service is created, updated, or deleted.
Order Events: When an order is created, updated, or deleted.
Task Events: When a task is created, assigned, completed, or updated.
Invoice Events: When the status of an invoice changes.
Client/User Events: When a new client is added, or a client/user is deleted.
Proposal Events: When a proposal is sent, received, accepted, or rejected.
Ticket Events: When a ticket is created, assigned, or its status changes.
Payment Events: When a payment is received or fails.
Service Package Events: When a service package is created, updated, or deleted.
Activate the Webhook
When Webhook is active, data will be sent for the selected events.
Activate the radio button.
Save the Webhook Configuration
Review the webhook configuration to ensure all details are correct.
Click “Save” to finalize and activate the webhook.
Review the webhook configuration to ensure all details are correct.
Click “Save” to finalize and activate the webhook.
Preview the Webhook
Click the just-created webhook to check the data.
You will see all the data of your selected events, including history, requests, and responses. You can also redeliver the information to your endpoint URL.
Important Notes
Testing: Before going live, test the webhook configuration to ensure data is being sent correctly to the endpoint.
Security: Ensure the endpoint URL is secure to protect the transmitted data.
Monitoring: Regularly monitor the webhook activity to ensure it functions as expected.
Updates: Periodically review and update webhook configurations to accommodate changes in your workflows or external systems.
Last updated
