Transactional surveys are sent when an external event is triggered. In simpler words, when something happens outside of Retently, a survey is triggered.
Retently email and in-app transactional surveys can be triggered by multiple external services.
In this article, we will cover how you can trigger a survey via Chargebee.
Set up Chargebee webhook notifications to trigger your survey in Retently
Chargebee webhook notifications let you notify external systems about an event that occurs in Chargebee. ticket's status change.
To create a new webhook notification, you will need to access the Settings > Configure Chargebee page in your account.
On the settings page, find the "API Keys and Webhooks" section, and access the "Webhooks" page.
On the "Webhooks" page, click the "Add Webhook" button, and a modal window will appear.
In the webhook notification builder, configure the fields as described below:
Webhook Name: Give your notification a name that will make it easily identifiable later on.
Webhook URL: Add the Retently webhook link from the campaign's Trigger or Setup section.
Protect webhook URL with basic authentication: Keep this option OFF.
API version: Choose "Version 2".
Events to Send: Choose one or more events. Check below in this article the list of supported events.
Set this as primary: Keep this option OFF.
Exclude card information from webhook call: Set this option ON.
Basically, your setup should look similar to this:
Retently's Chargebee integration supports all Chargebee webhook events that include the "customer" object (which means the customer's Chargebee details).
You can check Chargebee's official documentation on webhook events, and if an event returns the "customer" object, then you can definitely use it. Here's an example of a supported event as it's displayed in Chargebee's documentation:
Or you can simply choose an event from the list below:
Subscription Created
Subscription Created With Backdating
Subscription Activated
Subscription Activated With Backdating
Subscription Reactivated
Subscription Reactivated With Backdating
Subscription Cancelled
Subscription Cancelled With Backdating
The next part is important as it's related to choosing what contact data you will send to Retently when a ticket is updated. We will cover this in the next chapter.
Manage contact properties
When one or more selected events will be triggered in Chargebee, by default, Retently will accept and automatically map the following data:
Contact's email address
Contact's first and last names
Contact's company name
Additionally, there's a set of other properties that you can import to Retently along with your contact when an event is fired in Chargebee, specifically:
Plan ID
Billing period unit
Plan amount
Subscription status
MRR
NOTE: Please keep in mind that you will be able to import these additional properties only if the Chargebee event that you have selected returns the "subscription" object (information about the customer's subscription). You can check Chargebee's official documentation on webhook events, and see if the event that you're planning to use returns the "subscription" object.
If you need to send one or more of these properties to Retently, you will need to create them in Retently first, based on the instructions below:
In your Retently account, access the Attributes page, To create a new one, click the "Create property" button.
A popup will ask you to write the name of the new property and choose the type of value that will be stored in the new property. Use the property names and property types as follows:
cb_plan_id (property type: text)
cb_billing_period_unit (property type: text)
cb_plan_amount (property type: number)
cb_status (property type: text)
cb_mrr (property type: number)
Assign a property to a customer
After you have created the property or properties, they will be imported automatically along with your contact when a new event is triggered in Chargebee.
Update the value of an assigned customer property
The values in a property that is already assigned to a contact will be updated automatically the next time your event will be triggered.
Unassign customer property
Every time an event is triggered, the contact's properties will be updated with the new values that will be sent via the Retently webhook. However, if no value is available for a particular property, then the property will be unassigned from the contact's record in Retently.
Note: If you want to create more transactional campaigns, you have to add the new webhooks to the Chargebee events.
Click here to learn about other trigger services that we’re supporting.