Boulevard (BLVD)
Boulevard is the first and only client experience platform for appointment-based, self-care businesses.
Overview
Acquire and retain loyal clients with the Extole and Boulevard integration. This integration connects Boulevard's appointment management platform with Extole’s customer engagement and referral marketing platform. Automatically track when referred friends create, confirm, create, or cancel their appointments, and reward them and your advocates with one-time use discount codes (via Boulevard gift cards) that they can use towards their service. Plus, segment your referred clients in Boulevard for future marketing and promotions.
Prerequisites
Requirement | Description |
---|---|
An Extole Account | An Extole account is required for this integration. |
A Boulevard Enterprise Account | A Boulevard Enterprise account with Admin API permissions is required for this integration. |
Use Cases
- Create audiences and trigger actions (emails, rewards) in the Extole platform for clients who create, confirm, complete, or cancel an appointment.
- Automatically create and issue discount codes (gift cards) to participants who earn rewards in your Extole-powered programs.
- Segment your referred customers in Boulevard. Extole will automatically add a “referral” attribute to a client's Boulevard profile when they complete their appointment.
Integration
Use Case #1: Create audiences & trigger actions using BLVD client events
Use Boulevard webhooks to notify Extole as clients create, confirm, complete, or cancel an appointment.
First, obtain your Extole Access Token and Events API URL to begin configuring webhooks in Boulevard's platform.
Requirement | Description |
---|---|
Extole Access Token | A secure access token to authenticate and integrate with Extole’s Events API. Generate your token within the Security Center of your Extole account and save it in a safe place as you won’t be able to access it beyond this point. |
Extole Events API URL | The endpoint Boulevard will use to send client events to Extole. https://api.extole.io/v5/events |
Then, use the Boulevard platform to create webhooks for client created, appointment created, appointment confirmed, appointment completed, and appointment canceled events. You can keep the default data properties as is. Extole will map Boulevard’s default properties to Extole’s defaults in the Extole platform.
Example payload:
POST https://api.extole.io/v5/events/boulevard?access_token={$extole_token}
{
"apiApplicationId": "urn:blvd:ApiApplication:239a28183-ccc1a-501a-b88-348707",
"businessId": "urn:blvd:Business:304fhc82-65d1-4638-9cbf-6334ob514425",
"data": {
"node": {
"__typename": "Client",
"active": true,
"appointmentCount": 1,
"createdAt": "2024-02-06T12:42:55.577980Z",
"dob": null,
"email": "[email protected]",
"externalId": 1234,
"firstName": "John",
"id": "urn:blvd:Client:4e934730-tdcb-4b4e-8641978f1f3971324f9",
"lastName": "Doe",
"mergedIntoClientId": null,
"mobilePhone": "+18888888889",
"name": "John Doe",
"tags": [],
"updatedAt": "2024-02-06T12:42:55.577980Z"
}
},
"event": "client.created",
"eventType": "CLIENT_CREATED",
"idempotencyKey": "8372487-47asd7a-fdff-83329-505515e5347ffc",
"resource": "Client",
"timestamp": "2024-02-06T12:42:56.634078Z",
"webhookId": "urn:blvd:Webhook:45fd98-2391-41ba-9776-67b5594b15674ae"
}
Once you’ve configured your webhooks in Boulevard, your Extole implementation team will configure your Refer A Friend campaign to handle the events.
Use Case #2: Create and issue Boulevard discount codes (gift cards)
Use Boulevard gift card codes to give clients a discount towards their first or next service as they complete certain actions (e.g., appointment completed). When a participant earns a reward in your Extole-powered programs, Extole will fire a real-time mutation to Boulevards graphQL Admin API using outbound webhooks in order to create a unique gift card code. Once the code has been created, Extole will automatically distribute the gift card code to the participant via email.
First, provide the following values to your Extole team so that they can set up a connection to Boulevards Admin API.
Field | Value |
---|---|
businessId | Your business ID. |
api_secret | Your Admin API application's secret key. |
api_key | Your application key for the Boulevard Admin API. |
Then, your Extole team will create a webhook with the following properties. This will automatically create a gift-card code in Boulevard.
Webhook Event Property | Value |
---|---|
clientId | The ID of the client with which to associate the gift card. |
code | A randomly generated code for the gift card. |
locationId | The originating location for the gift card. |
note | Optional note to associate with the gift card order in the Boulevard platform. |
amount | The initial load value (in cents) for the gift card. |
Example payload:
mutation {
CreateGiftCard(
input: {
clientId: "urn:blvd:Client:015658d44a31-d641-43897-b7364-9873472ee43"
code: "bf67905b4e1b435daf39c3433f0"
locationId: "urn:blvd:Location:cb3339953458978-2bd3cf-4599-9778-216ca32478ee1"
note: "issued 25 USD reward"
amount: "2500"
}
) {
giftCard {
id
client
code
currentBalance
}
}
}
Use Case #3: Segment referred customers in Boulevard
You can also create lists of referred clients in Boulevard using the Extole integration. Provide the following values to your Extole team, who will then create a webhook that fires a mutation into Boulevard's graphQL Admin API when a referred client completes their appointment. The webhook will contain the following properties.
Webhook Event Property | Value |
---|---|
name | A name to represent the segment of clients. By default, Extole will use “Referrals” however this can be customized. |
symbol | An emoji used to represent the Client Segment. By default, Extole will use “👯♀️” however this can be customized. |
Customizations
To test gift card codes in your staging environment, work with your Extole and Boulevard teams to set up a separate staging API integration in the Extole platform.
Updated 6 months ago