Webhooks in CareCloud API

Webhooks are an efficient way to forward notifications about data changes or actions performed within the CareCloud platform to other systems

Discover more
Get in Touch

How Webhooks Work

CareCloud supports webhooks specifically in the Marketing Automation (MA) application, allowing you to define scenarios that trigger webhook calls.

  1. Setup: A CareCloud administrator configures a Marketing Automation scenario that includes webhook settings.
  2. Event Trigger: When a customer performs an action that generates an event in MA, the defined scenario is initiated.
  3. Notification Sent: MA sends a notification, along with any requested data, to the specified target URL via an HTTP request.
  4. Data Reception: The e-shop receives the webhook notification and accompanying data.
  5. Data Processing: The e-shop can process the received data or make additional API calls to CareCloud for further information if needed.

Webhook Configuration

You can configure a webhook with the following parameters to ensure proper functionality and security:

  • Target URL: This is the endpoint where CareCloud will send notifications or data. It must be a publicly accessible URL that can handle incoming HTTP requests. Make sure the server at this URL is set up to receive and process the incoming data effectively.
  • Authentication Method: This parameter specifies how the webhook will authenticate itself when sending requests to your target URL.
    It's crucial to choose an authentication method that aligns with your security policy and ensures that only authorized requests are processed.
  • Data Structure: Define the format and structure of the data that will be sent with the webhook notifications. JSON is used to format structures. It is the most common format, allowing for easy parsing and integration with modern applications.

 

By clearly defining these parameters during webhook setup, you can optimize the integration process and ensure that your application receives timely and accurate notifications from CareCloud.

For detailed instructions on setting up a webhook in Marketing Automation, refer to the guide: How to Set Up Webhooks in Marketing Automation.

Supported Data Structures

CareCloud can send various data structures to your target URL based on your webhook configuration. These structures mirror those used in the CareCloud API.

kreslo

JOIN OUR CLOUD

Ready to Meet CareCloud?

Fill in your contact details to get answers to the questions you have about CareCloud – from product description and pricing to casual talk about your customers and your business.

One of our experts will contact you soon.

By submitting this form, you confirm that you agree to the processing of your personal data by Cortex and contacting you to fulfill your request. Your data will be deleted after we meet your request unless a mutual agreement on further processing has been concluded. Your data is secure.