Webhooks (Available on Selected Plans)

Webhooks (Available on Selected Plans)

The Webhooks Module for DigifyCRM allows real-time communication between DigifyCRM and other services that support webhooks. This enables automated workflows and information exchange triggered by events within DigifyCRM, making integrations with external apps seamless and efficient.

Key Features:

• Supported Functions: Webhooks can be created for various DigifyCRM functions, such as:
  • Leads

  • Customers (Add/Delete Contacts)

  • Invoices

  • Tasks

  • Projects

  • Estimates

  • Proposals

  • Tickets

  • Payments

  • Staff

  • Custom Fields

  • Contracts

  • Calendar Events

• Supported Events:
  • Create

  • Update

  • Delete

  • Accept, Decline, Sent (for proposals)

• Supported Methods: The following HTTP methods are supported:
  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

  • Status Change (for leads)

• Supported Request Headers: Webhooks can include standard HTTP headers such as:
  • Authorization

  • Content-Type

  • Accept-Encoding

  • User-Agent

  • And custom headers can be defined as well.

1. Understanding Webhooks vs REST API

• Webhooks: Trigger real-time data sharing when an event occurs (one-way communication).

• REST API: Requires a request to retrieve or send data (two-way communication).

• Webhooks: Less resource-intensive, delivering real-time updates when triggered by specific events, whereas APIs require continuous polling.

2. Creating Webhooks

Webhooks allow DigifyCRM to send data to other platforms in real time, based on specific events (e.g., creating a new lead, updating a contract). Here’s how to create webhooks in DigifyCRM:

Steps to Create a Webhook:

1. Navigate to Webhooks Module:

• Go to Webhooks > Create New Webhook.

• Choose the trigger event (e.g., when a lead is created or updated, an invoice is generated).

• Select the HTTP method (GET, POST, PUT, PATCH, DELETE) depending on the type of request needed.

• Enter the URL of the external service where the data will be sent when the webhook is triggered.

• Define any necessary HTTP headers such as Authorization, Content-Type, or any custom headers.

• Use a test event in DigifyCRM to trigger the webhook and verify that the data is being sent and received correctly by the external service.

• Once configured, save the webhook for it to be active in the system.

3. Supported Modules and Functions

Webhooks can be used with multiple modules in DigifyCRM. The following are some common uses:

Leads:

• Automatically send lead data to third-party platforms when a lead is created, updated, or deleted.

Invoices:

• Notify external accounting systems when a new invoice is generated or updated in DigifyCRM.

Projects:

• Trigger webhooks when a new project is created or updated, helping project management tools sync with DigifyCRM.

Tasks:

• Automatically update task management software when tasks are created, modified, or completed.

Payments:

• Webhooks can be triggered when a payment is processed, sending real-time notifications to external services for further actions like billing updates or analytics.

Contracts and Proposals:

• Send proposal status updates or contract approvals to external systems for tracking and notifications.

4. Additional Features

Custom Fields:

• The module supports custom fields, allowing you to send personalized data from DigifyCRM to external applications through webhooks.

Cloning Webhooks:

• You can clone existing webhooks to quickly create new ones with similar configurations.

Delayed Trigger Execution:

• Set up delayed webhook triggers that execute after a predefined time interval (minutes, hours, days). For example, you can send a follow-up notification a few hours after a lead is created.

5. Managing Webhooks

Once you’ve created a webhook, you can manage and monitor its performance.

Steps to Manage Webhooks:

1. View Webhooks:

• Go to Webhooks > Manage Webhooks to view all active webhooks.

• Click on any webhook to edit its settings or delete it if it is no longer needed.

• Check webhook logs to monitor successful and failed requests and analyze any errors.

• If you need a similar webhook for another service, use the clone feature to duplicate it and make necessary changes.

6. Examples of Webhook Use Cases

Example 1: Webhook Integration with Zapier

• You can set up a webhook in DigifyCRM that triggers whenever a new lead is created. This webhook sends the lead data to Zapier, which can then automate a series of actions, such as adding the lead to an email list or sending a welcome email.

Example 2: Webhook Integration with MailChimp

• Automatically add new customers from DigifyCRM to your MailChimp mailing list via a webhook. Whenever a customer is added to DigifyCRM, the webhook sends the customer data to MailChimp to update your newsletter list.

Example 3: Webhook Integration with Xero

• A webhook can be triggered when a new invoice is created in DigifyCRM, sending the invoice data to Xero for accounting purposes.

7. Limitations and Compatibility

• Password Handling: Do no handle passwords using Webhooks.

• Unsupported Tasks: Webhooks cannot support updates for tasks.

• Leads: Core actions are used for deleting leads, as webhook deletion is not supported for this function.

8. Best Practices for Using Webhooks

• Testing: Always test your webhook setup before enabling it in production to ensure that data is correctly sent and received.

• Security: Use secure endpoints (HTTPS) for webhook URLs and set up authorization tokens in the header to ensure the security of your data.

• Logs: Regularly check webhook logs to monitor errors or data discrepancies.

Performance: Use delayed trigger executions when handling non-critical updates to avoid overwhelming external systems with immediate data pushes.