Birdeye supports REST-based APIs to send review requests to your customers. The API requires your account's unique API Key and Business ID to be able to send customer data to Birdeye to send out review requests.

Before you start the automation process using custom API, ensure that your customer management platform is able to integrate with an open REST API. Also, ensure you have the Business ID and API Key associated with your Birdeye account handy. 

To generate the API Key and to find the Business ID associated with your Birdeye account, click on the 'Settings' tab on the left navigation rail, then go to the 'Integrations' tab, and select the 'API' option. 

Click on the 'Generate API key' button, to see your 'Business ID' and 'API' key.

After you have obtained your unique 'Business ID' and the 'API key', navigate to https://developers.birdeye.com to find the API script for customer check-in. On the homepage, click on the 'Customer' tab located on the left navigation rail.

On the 'Customer' page, find the POST Command for API calls under the 'Customer Checkin' header. You can use this POST Command to send the customer data to Birdeye. Replace the Business ID labeled as 'bid' with your Business ID and the API Key labeled as 'api_key' with the API key for your account. If you are using Salesforce CRM, you can use the Apex trigger to invoke the REST API and then utilize the POST Command to send data to Birdeye.

If you send the POST Command with wrong information or invalid credentials, Birdeye will return an error code. List of different types of error codes is provided at the bottom of the 'Customer Checkin' header. If you receive any of the error codes specified in 'Customer Checkin' documentation, make sure to cross-check the data that you are sending Birdeye.

API integrations are immediate and will instantly let you know if your integration was successful or not. If the API call is unsuccessful, you will receive an error code. If the API call is successful, Birdeye will send out review requests as per the settings within your Birdeye dashboard.