Overview
To connect Ingrid to Bloomreach, you create API credentials in Bloomreach, send them to Ingrid, and Ingrid sets up the integration for you.
Once live, Ingrid delivery events (for example out for delivery, delivered, delivery failed or ready for pickup) are sent to Bloomreach as customer events. You can then use them to trigger delivery emails and other customer communication from Bloomreach scenarios.
For what the integration does and what you can do with it, see Bloomreach integration.
Before you start
Access to your Bloomreach project with permission to manage Access management and API settings.
A clear idea of which delivery updates you want to communicate to your customers. You can find the events in the Ingrid events catalog.
Customer records in Bloomreach identified by email address, so delivery events can be matched to the right customer.
Steps in Bloomreach
Open API settings. In your Bloomreach project, open Project settings. In the left menu, under Project, expand Access management and select API.
Copy your project credentials. At the top of the API page, copy the Project token and the API base URL. Each field has a copy button next to it.
Choose a Private API group. Under API groups, open the group menu and select a Private group, or create a new one for Ingrid. Make sure it's a Private group, not a Public one.
Copy the group keys. Under Group keys, each key is listed with its Key name, API key ID and API secret. Copy the API key ID and the API secret. If you need a new key, select + Add key.
Set the group permissions. Under Group permissions, use the tabs at the top of the list:
Customer properties tab: in the Other list, tick Get and Set for email (required).
Events tab: tick Get and Set for New events at the top, so Bloomreach accepts Ingrid delivery events as they arrive. The Ingrid events catalog lists the available events.
Save. Select Save changes in the top-right corner. Keep the four values from steps 2 and 4 ready to share with Ingrid.
Value to share | Where to find it |
Project token | Access management → API |
API base URL | Access management → API |
API key ID | API groups → Group keys |
API secret | API groups → Group keys |
Send the details to Ingrid
Where you send the details depends on where you are with Ingrid:
Your status | Send the details to |
Already live with Ingrid | Iris, Ingrid's AI assistant, in the chat on the Ingrid Help Center |
Currently implementing Ingrid | Your Ingrid Implementation Consultant |
Include:
Your company name and Ingrid site/account name
The four Bloomreach values listed above
The delivery updates you plan to use in Bloomreach (for example out for delivery, delivered, delivery failed)
The API secret gives access to your Bloomreach project. Share it only through the channels above and never in public or shared group channels. You can use secret.ingrid.build to securely share the secrets with Ingrid.
What happens next
Ingrid sets up the integration and gets back to you when it is ready for testing. After that:
Build your scenarios. In Bloomreach, create scenarios that listen for the Ingrid delivery events you want to use, and add the delivery details to your email templates.
Test together. Ingrid sends test events to your Bloomreach project. Check that they appear on the right customer profile and trigger the expected scenario.
Go live. Once you confirm the tests look right, Ingrid switches on live delivery events.
Event names in Bloomreach follow the Ingrid delivery event names listed in the Ingrid events catalog, which is updated as new events are added. To add a new type of message later, create a new scenario for that event in Bloomreach; no change is needed on the Ingrid side.