🕸️Integration Guide

Chup Online Webhook Integration Guide

I. Overview:

This document outlines the step-by-step process for integrating external applications with Chup Online using webhooks. Webhooks enable real-time notifications of events occurring within Chup Online, allowing external applications to react accordingly and automate workflows.

II. Supported Event Types:

Chup Online webhooks notify you of various events categorized into:

• Appointment: appointment_created, appointment_updated, appointment_deleted

• Live Queue: live_queue_created, live_queue_updated, live_queue_deleted

• Client: client_created, client_updated, client_deleted

• Service: service_created, service_updated, service_staffs_updated, service_deleted

• User: staff_created, staff_updated, staff_services_updated, staff_deleted

III. Integration Steps:

A. Chup Online Webhook Configuration: [link]

1. Enable Webhooks: Determine the type of webhook you need (e.g., outgoing) and the external application endpoint URL that Chup Online will send payload to.

2. Define Outgoing URL: This URL is your endpoint in the external application where Chup Online will send webhook. Provide the complete URL with authentication details (if applicable) in the designated field.

B. Authenticate Your System [link]

• Utilize the given api_key, business_id and email to generate a bearer token for your sessions.

• Securely store this bearer token as it will be used to authorize your interactions with the Chup API.

C. External Application Setup:

1. Create Endpoint: In your external application, create an endpoint that can receive HTTP POST requests containing JSON-formatted webhook data from Chup Online. Ensure it can handle different event types and process the data accordingly.

2. Data Persistence: Implement mechanisms to store received webhook data in a suitable database or data structure for further processing or analysis.

D. Sample Alert Action:

1. Retrieve Token: Use the Chup Online auth endpoint (https://api-chup-online.readme.io/reference/post_user-auth-login) with valid credentials to acquire an authentication token.

2. Trigger Alert: Employ the Chup Online alert endpoint (https://api-chup-online.readme.io/reference/put_user-visits-visit-id-alert) to send alerts to patients, utilizing the acquired token for authorization. Pass the relevant patient identifier (visit_id) and customize the alert message.

E. Video Demo

---