Bud integration User Guide

This comprehensive guide is for all users of the Bud apprenticeship management integration. The integration synchronises student Functional Skills Course completion data from the Pass platform to Bud's Gateway API and Data Warehouse systems.

What does the integration do?

Integration Purpose

The Bud integration provides synchronization of:

Functional Skills Course Learning Progress is updated in Bud after the student completes them in the Pass platform

How it works

Functional Skills Course Progress is passed to Bud and updated against the Functional Skills section as the learner completes topic areas in the Pass Platform.

Important:

Activities in Bud must be set up with a special prefix, in order for the Pass Platform to correctly mark the activity as complete in Bud.

Limitations

This integration ONLY updates Course progress, it does NOT update Initial Assessments / Diagnostic results in Bud.

Prerequisites

Before enablement, ensure you have:

Valid Bud Business Account with Gateway API access
Data Warehouse connection credentials from Bud support
OAuth 2.0 Client credentials (Client ID & Secret)
Network connectivity to both https://api.bud.co.uk/ and the DWH server
Activities in Bud MUST include a Topic Area Shortcode prefix (more below).

Enabling the Bud Integration

Request API Access: Contact Bud Support to enable Gateway API access. You should receive a client id and client secret, which will then need to be provided to our team.
Request Data Warehouse Access: Contact Bud Support to enable Data Warehouse Access for Pass. You should receive a username and password, which will then need to be provided to our team.
Configure Bud Activities: Contact Pass Support with a list of the topic areas you wish to track. We will provide you with a list of short_codes, which must be set as the prefix of your bud activity names (e.g. “FSML2996761 Using Numbers”).
Provide to Our Team: Share the credentials listed above with our Technical Support Team
Configuration & Testing: Our team configures and tests the integration
Activation: Integration is enabled for your organisation. We will confirm the integration is active via email.

Support & Resources

Bud Documentation

Bud Support: https://support.bud.co.uk/hc/en-gb/sections/4412324003473-API
Data Warehouse: Provided separately by Bud (requires PowerBI access to schema)

Contact Technical Support

For integration issues, contact our Technical Support Team with:

Error message or issue description
Student email or ID affected
Specific activity or programme aim involved
Screenshots of the error (if applicable)

Troubleshooting

Issue: Activity completion not updating in Bud

Solution: Confirm both API and Data Warehouse connections are active. Check that activity short code matches Bud records and that the student has the correct Programme & Activities applied in Bud.