The information in this document is confidential, privileged, and only for internal Birdeye users. This document may not be used, published or redistributed.
This integration is supported for SMB businesses.
Integrating Birdeye with MYOB
User Manual - SUPPORT ARTICLE
MYOB is an Australian bookkeeping, tax, and accounting software company designed for a variety of businesses, large and small, to help them manage multiple accounting processes. It offers a range of products, including essentials payroll, MYOB essentials, and MYOB account rights, which is ideal for various businesses.
Businesses can use MYOB to manage accounts for different stakeholders. Integrating MYOB with Birdeye will automate the process of sending out review requests to customers on a daily basis.
Once MYOB CRM is integrated with Birdeye, Birdeye will pull client information from MYOB CRM once daily. Birdeye collects your client's first name, last name, email address and phone number and automatically sends them review requests based on the preferences set within the Birdeye dashboard.
Table of Contents
Information required from the Business
Trigger details
Company GUID
Invite Birdeye user to the company file
Location name
Business ID for single-location business
Login
Manage Triggers
Manage Properties
Manage Locations
Important Instructions for Email opt-in/ opt-out
Restriction Reason
Description
Integration Requirements
Triggers Supported
Birdeye allows you to fetch data from Myob using predefined triggers. You can choose any combination from the list of available triggers and inform the support team about your selection. Here are the supported triggers for Myob:
Trigger Display Name | Trigger Name/Value | Trigger Description |
MYOB Sales Orders Trigger | Sales Orders | This trigger is used to fetch customer data based on the sales orders. |
MYOB Paid Invoices Trigger | Paid Invoices | This trigger is used to fetch customer data based on fully paid invoices. |
Details required from the Myob dashboard
Trigger Details
Invite Birdeye user to the company file
NOTE: To fetch MYOB customers of a particular company, Birdeye needs to be invited from the Myob App.
Details required from the Birdeye dashboard
Business ID in case of an SMB Business
Information from Birdeye Dashboard
For an SMB account - Business ID.
Login to your Birdeye account, go to the left navigation rail, and click ‘Settings’. Once the new page appears, click on ‘Integrations’ and select ‘API’.
You will find the ‘Business ID’ and ‘API key’ shown in the image.
Integration Process
Before you can integrate MYOB with Birdeye, you will need to set up the following configurations on the integrations support dashboard:
To set up native integration, we have an integration support dashboard, where we need to set up the integration and then follow these steps to complete the configuration— https://integrations.Birdeye.com/sign-in/
Login
After successful login in the integration dashboard, you have to click on ‘BE integration’ and then click on ‘Add Integration’.
Search for the Myob Crm in the search bar and select it. Click on ‘Next’.
Manage Triggers
Select the Trigger Name (Check Box) as per the client’s requirement and click ‘Next.’
Note: To fetch information for all the triggers available using curl commands, use this command. To replace triggers, use this curl command.
Manage Properties
Here; you can manage group-level properties, which will be applied to all locations under a CRM.
Sales Order Types: Enter the comma-separated sales order types for which sales orders need to be filtered out. The possible sales order types are Item, Service, Professional, TimeBilling, and Miscellaneous.
GUID of Company File: Enter the GUID of the company file provided by the client.
Customer Fetch Delay: It is used if businesses want to send review requests with a delay(number of days).
Invoice Types: Enter the comma-separated invoice types for which invoices should be filtered out. The possible invoice types are Item, Service, Professional, TimeBilling, and Miscellaneous.
Note: This step will create a group for our integration. Alternatively, you can do it via curl commands.
For SMB accounts, you can access the curl command.
How to find the GUID of the Company File
The GUID can be found in the MYOB App URL, as shown in the image below.
For instance, the GUID will be the highlighted part which is; 4bbabd17-dfaf-444d-b0ba-7e5b0d824749
Manage Locations
For SMB Accounts, select the drop-down and click on ‘Add.’
A drawer will appear on the right-hand side.
The Status, Frequency and Next RunTime will be set by default. You can make changes if required.
Status: It shows the status of integration (Active or inactive).
Frequency: It is the number of times integration will sync with CRM (Days or Hours).
Next RunTime: The next scheduled time is when the integrations will run.
Customer fetch delay: It is used if businesses want to send review requests with a delay (number of days).
Override Group Properties: With this, you can override the Customer Fetch Delay property added at the group level, specific to each location.
Click on ‘Next’ and click on ‘Save.’
Note:
For SMB & Enterprise business: You can use ‘manage the locations’ using this curl command.
Authorize through Integration Dashboard
The rest of the setup is to be completed within the business Birdeye dashboard:
On the bottom of the ‘Settings’ page, click on the 'Authorize Myob' button under the CRM integrations header. This button appears only after the above steps (curl commands) have been completed.
Once you click the authorization button, you will be redirected to the Myob website. Enter the email address and click 'Next.’
Enter the password associated with the business's Myob account and click 'Sign In.’
After you have successfully signed in to the Myob account, it will send the verification code to the email address you provided. Enter the authentication code and click the 'Verify' button on the bottom right to continue the integration process.
You will be redirected to the Birdeye dashboard, and an 'Authorized' message will appear next to Myob.
Once you are successfully authorized with Myob, you can disconnect anytime by clicking on the 'Disconnect Myob' button beside 'Authorized.’ Once you are disconnected, you can no longer fetch customer information from MYOB. The 'Disconnect Myob' button will change to 'Authorize Myob.’
NOTE: Once the setup is complete, the integration runs once daily and pulls data for the previous day to send out review requests as per the configuration setup within the Birdeye dashboard. For instance, If XYZ firm check-in 10 customers on Monday, the review requests to the customers will be sent automatically on Tuesday.
Curl Commands
Before you can integrate MYOB with Birdeye, you will need to set up the following configurations:
A business integration group is a configuration that supports the business hierarchy of individual businesses on the Birdeye platform. The properties that are common for all business integrations are entered at the group level. Setting up a business integration group allows you to associate multiple business locations with the Enterprise account. Below is the list of curl commands you will need to run to set this up.
Create Integration Group for SMB Business (Curl Command)
Copy this Curl Command
curl --location --request PUT 'https://common-services.Birdeye.com/integration/add/businessintegrationgroup' \
--header 'cache-control: no-cache' \
--header 'content-type: application/json' \
--data-raw '{
"parentBusinessNumber": 159894423800397,
"integrationSourceId": 127,
"integrationGroupProperties": [
{
"propertyKey": "company_id",
"propertyValue": "4bbabd17-dfaf-444d-b0ba-7e5b0d824749",
"isSecure": false
},
{
"propertyKey": " myob.invoice.types",
"propertyValue": "Item,Service",
"isSecure": false,
"triggerId": 144
},
{
"propertyKey": " myob.sales.order.types",
"propertyValue": "Item,Service",
"isSecure": false,
"triggerId": 145
},
{
"propertyKey": "customer.fetch.delay",
"propertyValue": "0",
"isSecure": false
}
],
"integrationGroupTriggers": [
{
"triggerId": 144,
"triggerTypeId": 1
},
{
"triggerId": 145,
"triggerTypeId": 1
}
]
}'159894423800397- Business ID - This is Business ID for a single location SMB account
144, 145- Integration Trigger ID - Can be one or more triggers. Ask the client what trigger they would like to integrate with, then run the curl command to fetch all possible triggers for Myob. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
Fetch information for all the triggers available for Myob (Curl Command)
Copy this Curl Command
curl --location --request GET 'https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/127' \ --header 'cache-control: no-cache' \ --header 'content-type: application/json'
Sample response: A sample response like this would appear after you run the curl command. The response will have the trigger name, description and ID. This trigger ID will be utilized while creating the integration group. Integration can have one or more triggers. To use more than one trigger, enter comma-separated values while creating the integration group.
[
{
"id": 145,
"triggerService": "myobSalesOrderTriggerService",
"displayName": "MYOB Sales Order Trigger",
"description": "This trigger is used to fetch customer data based on sales orders",
"active": true,
"integrationTriggerType": {
"id": 1,
"name": "JOB"
},
"actionGroupId": 1,
"sourceIdsList": [
127
],
"triggerName": "Sales Orders",
"caseTypeId": 1
},
{
"id": 144,
"triggerService": "myobPaidInvoicesTriggerService",
"displayName": "MYOB Paid Invoices Trigger",
"description": "This trigger is used to fetch customer data based on fully paid invoices",
"active": true,
"integrationTriggerType": {
"id": 1,
"name": "JOB"
},
"actionGroupId": 1,
"sourceIdsList": [
127
],
"triggerName": "Paid Invoices",
"caseTypeId": 1
}
]Find business integration group details (Curl Command)
Copy this Curl Command
curl --location --request GET 'https://common-services.Birdeye.com/integration/businessintegrationgroup/159894423800397' \ --header 'Cache-Control: no-cache'
Sample Response
24234- Group ID: A group ID will be returned in the sample response with the details of the existing triggers for a business.
159894423800397- Business ID: Enter the Business ID here to get the integration group details for a business.
{
"groupId": 24234,
"integrationSourceType": {
"id": 127,
"integrationSource": "MYOB",
"sourceCategory": "Accounting",
"integrationType": "Birdeye API",
"crmName": "Myob",
"integrationPlan": "Standard",
"oauthEnabled": true
},
"integrationGroupTriggers": [
{
"triggerId": 144,
"triggerTypeId": 1,
"actionIds": [
1
]
},
{
"triggerId": 145,
"triggerTypeId": 1,
"actionIds": [
1
]
}
]
}
]Trigger Information: Only required if the client wants a change (Curl Command)
Copy this Curl Command
curl --location --request POST 'https://common-services.Birdeye.com/integration/update/businessintegrationgroup?replaceTriggers=true' \
--header 'cache-control: no-cache' \
--header 'content-type: application/json' \
--data-raw '{
"groupId": 24234,
"integrationGroupTriggers": [
{
"triggerId": 144,
"triggerTypeId": 1
},
{
"triggerId": 145,
"triggerTypeId": 1
}
]
}'replaceTriggers=true -To replace existing trigger(s), enter the value for replaceTriggers as true. To add a new trigger(s) to the existing list, the value for replaceTriggers should be false.
24234- Group ID: The Group ID which was returned in the previous step will be entered here.
144, 145- Trigger ID: Enter the Trigger ID (s) which need to be added or updated to the integration.
Integration Location Mapping
Integration Mapping (SMB Businesses)
Once the Integration Group is created, the next step is to create the Integration Mapping.
Copy this Curl Command
curl --location --request PUT 'https://common-services.Birdeye.com/integration/add/businessintegrationmapping' \
--header 'cache-control: no-cache' \
--header 'content-type: application/json' \
--data-raw '{
"businessNumber": 159894423800397,
"integrationGroupId": 24234,
"integrationProperties": [
{
"propertyKey": "customer.fetch.delay",
"propertyValue": "0",
"isSecure": false
}
],
"active": true,
"test": false,
"beta": false
}'159894423800397- Business ID: Enter the Business ID for the SMB Business.
24234- Group ID: Enter the Group ID, which was returned when the Integration group was created.
true - Active: Enter true to enable the integration.
Appendix
Restriction Reason and exceptions
Restriction reason is used to identify the contacts who have opted out (restricted) from sending a review request. This reason can be fetched from Kibana for contacts already checked in. Also, the exceptions can be seen on the integration dashboard or Kibana error logs.
Possible restriction reasons or exceptions for Myob are:
If the sales order or invoice type is not configured in the sales order or invoice type field, that needs to be filtered.
The customer is inactive.
Phone or Email should be valid for creating a customer. Email: null, Phone: null.
Integration is beta.
The invoice Balance is not zero.
Description
If the sales order or invoice type is not configured in the sales order or invoice type field, that needs to be filtered.
The customer is inactive.
Phone or Email should be valid for creating a customer. Email: null, Phone: null.
Integration is beta.
The non-zero invoice balance indicates that the invoice is not fully paid.
Troubleshooting Steps
If you encounter any of the above restriction reasons, the steps are below to follow.
If the sales order or invoice type is not configured in the sales order or invoice type field, that needs to be filtered.
Configure the respective sales order and Invoice types to get the data.The customer is inactive.
Check whether the customer is active or not.Phone or Email should be valid for creating a customer. Email: null, Phone: null.
Check the email address and phone number.Integration is beta.
Please look up the key beta in kibana to know whether the integration is beta or not.The invoice Balance is not zero.
Please make sure to pay the full amount of the Invoice in MYOB.