API
Prepare Team Custom Credentials endpoint (Aug 2024)
The new Prepare Team Custom Credentials endpoint provides instructions for preparation of Bring Your Own OAuth custom credentials.
You can use the information to configure things like OAuth callback URI and the Webhook URI (if applicable), before activating it on your Vital Team through the Set Team Custom Credential endpoint.
Org Management API is available for the Scale plan.
Azure Event Hub: Flexible routing (Aug 2024)
You can now configure your Azure Event Hub destination in ETL Pipelines to route Vital data events to different Event Hubs based on their event type prefix.
Check out the ETL Pipelines - Azure Event Hub documentation.
ETL Pipelines are available for the Scale plan.
Azure Event Hubs as ETL Pipeline destination (Jun 2024)
You can now receive events from Vital directly with your Azure Event Hubs.
Check out the ETL Pipelines documentation.
ETL Pipelines are available for the Scale plan.
Manage Team Brand Information (Apr 2024)
You can now manage Brand Information of your Vital Teams through the Org Management API.
Team Brand Information is used in:
- the Vital-hosted Link widget;
- all user communications Vital Lab Testing sent on your behalf; and
- the Vital-hosted Appointment Booking page for Vital Lab Testing.
Org Management API is available for the Scale plan.
Check out the Update Team and Create Team endpoint documentation.
Vital Orgs and Org Management API (Apr 2024)
We have introduced Vital Org, a new level that groups all your Vital Teams. Your Vital Teams have been transparently grouped and migrated to the new structure.
We introduced this to provide a unified billing and administrative experience for customers having these use cases:
- multi-region presence; or
- user organization with diverging team-level configurations.
We introduced the Org Management API because customers have asked for the programmatic access to dyanmically create Vital Teams and manage different aspects of their Vital Teams.
Org Management API is available for the Scale plan.
Check out the Org Management API documentation.
New webhook event top-level fields (Mar 2024)
All events now include Team ID, User ID and Client User ID as top-level fields.
We introduced this because this helps reduce a Vital User ID -> Client User ID database lookup on your end.
Check out the Webhook Event Structure documentation.
Before
After
Improved error response for User creation conflicts (Mar 2024)
The Create User endpoint has improved handling of conflicts in Client User ID.
We introduced this because the user creation endpoint being idempotent can help simplify your application logic.
When the supplied client_user_id conflicts with an existing user, the 400 Bad Request response
now includes the Vital User ID (user_id) and the creation date (created_on) of the conflicting user.
Check out the Create User endpoint documentation.
User Undo Deletion (Feb 2024)
You can now undo user deletion that is still in the 7-day grace period.
Check out the User Undo Deletion endpoint documentation.