Developer API Documentation
Integrate seamlessly with our ComBee platform using our powerful RESTful API
/// Introduction
Bloom Software's platforms BeeSMART, ComBee and the #DoYourBit mobile app are the trusted software platforms behind some of the UK's biggest charity lotteries.
The ComBee Core External API provides secure, programmatic access to key areas of the ComBee Lottery Management Platform, allowing charities and fundraising organisations to seamlessly integrate with tools like Power Automate, Zapier, and other automation or CRM platforms.
With this API, you can streamline supporter engagement, automate back-office tasks, and enhance communications with minimal developer effort.
/// Key features
Customer management
Submit new lottery sign-ups
Query and update customer records
Capture full contact and consent preferences
Draws
Retrieve draw details
Fetch and process prize winner data
Mailing Integration
Access lists of customers subscribed to marketing channels (Email, SMS, Post, Phone)
Pull personalisation metadata for new players or prize winners
Power your automated campaigns with dynamic content
Webhooks
Register callback URLs
Subscribe to ComBee events (e.g. signups, payments, winners)
Receive real-time notifications via your own systems
/// Ready to start building?
To use the API, you'll need an API key.
Include it in the header as follows:
API keys are manually issued on request from your usual contact at Bloom Software or Bee-Ethical, and are linked to specific ComBee user accounts.
Requests without a valid key will return: 401 Unauthorized.
X-External-ApiKey: <api-key>
Our full developer documentation contains all available endpoints, request/response formats, error handling details, and example payloads to help you get fully integrated.