Webhooks allow administrators to automate the transfer of service delivery data to external systems, such as billing software. This guide provides a step-by-step process for setting up a webhook.
Service Delivery Integration Overview
As an administrator, you may need to send various service delivery data from Casebook to your billing software. This includes:
- Service Enrollments: Information regarding the enrollment of individuals or groups into specific services.
- Service Notes: Documentation related to the services provided, including interactions, outcomes, and observations.
- Service Offerings: Details about the services available, including descriptions, availability, and eligibility criteria.
- Funding Sources: Data related to the financial resources used to support the services, including grant details, budget allocations, and payment sources.
Step-by-Step Guide to Setting Up a Webhook
Accessing the Webhooks Configuration
-
Navigate to the Integrations Tab:
- In the Casebook admin interface, go to the Integrations section.
- Select the Outgoing tab to view existing webhooks.
-
Review Existing Webhooks:
- Here, you’ll find a list of configured webhooks. Each entry displays essential information such as:
- Name: The identifier for the webhook.
- Endpoint URL: The destination URL where data will be sent.
- Description: A user-provided explanation of the webhook’s purpose.
- Resource: The specific data being sent through the webhook.
- Here, you’ll find a list of configured webhooks. Each entry displays essential information such as:
Creating a New Webhook
-
Initiate Webhook Creation:
- Click the + icon located at the bottom right-hand corner of the screen to create a new webhook.
-
Configure the Webhook:
- In the modal that appears, fill in the required fields:
- Webhook Name: Give your webhook a meaningful name that reflects its function.
- Endpoint URL: Enter the URL of the external system (e.g., your billing software) where the data will be sent.
- Description (Optional): Add a brief description to clarify the webhook’s purpose.
- In the modal that appears, fill in the required fields:
-
Select the Data to Include:
- You’ll see checkboxes at the bottom of the modal representing the different data types you can include in the webhook payload. These may include:
- People
- Funding
- Service Delivery
- If you do not select any checkboxes, the webhook will default to sending all available data.
- You’ll see checkboxes at the bottom of the modal representing the different data types you can include in the webhook payload. These may include:
-
Save the Webhook:
- Once all fields are completed and selections are made, click Save to finalize the webhook setup.
Value and Benefits of Webhooks
Enhanced Interoperability
- Automatic Data Transfer: Webhooks enable seamless communication between Casebook and your external systems, reducing manual data entry.
- Increased Accuracy: By automating data transfer, you minimize the risk of errors that can occur with manual entry, ensuring consistency across platforms.
Improved Efficiency
- Time Savings: Webhooks automate routine data-sharing tasks, freeing up your staff to focus on more critical, value-driven activities.
- Resource Optimization: With less time spent on data management, your organization can allocate resources more effectively.
Scalability
- Seamless Integration: As your organization grows, webhooks ensure that Casebook remains flexible, capable of integrating with an expanding range of tools and systems.
- Future-Proofing: Webhooks provide a scalable solution that can adapt to your organization’s evolving needs, supporting ongoing growth.
Real-Time Data Synchronization
- Instant Updates: Changes made in Casebook are immediately reflected in connected systems via webhooks, ensuring that your data is always up-to-date across all platforms.