In this article, we'll discuss what Open API is and how to get connected
If you use niche or custom-built invoicing, job management, or customer relationship management (CRM) software, our Open API is here to make your life easier. It allows you to build a custom integration between your software and betterbunch, which automates the follow-up process completely, freeing you up to focus on what you do best.
Before you start building out your custom integration, we encourage you to check out this list of platforms we have integrated with already. If your software is not listed there, and your software platform has an Open API (check with them if you’re unsure), read on to learn how to automate using our Open API.
In simple terms, our Open API lets you seamlessly link your software with betterbunch. Your developer can follow the documentation and code below to make this connection. Once set up, whenever a defined trigger (such as job complete) is met within your software, betterbunch will receive the details – customer name, email, and phone number – and use that data to send out an invitation automatically.
Here's an example: Imagine a business with a custom-built CRM for managing their jobs. Their developer can easily integrate our Open API code into their CRM, and once it's active, whenever a job is closed or marked as complete, betterbunch will generate and send a feedback invitation.
Our Open API is "open" in the sense that we provide access for your developer to link the two software platforms, enabling your external software to generate feedback invitations automatically on your behalf.
Setting up automation with Open API is a breeze. Your technical team can insert a few lines of code into your invoicing, CRM or job management software, and voila!
Just a reminder, the betterbunch Open API is managed and maintained by us. The connection between your software and betterbunch needs to be built and managed by your own technical team. We are more than happy to work alongside you, but your technical team will remain responsible for the development and maintenance of the custom integration or Open API code provided by your software.
Ready to get started? Keep reading to learn how to make the connection.
Creating Invitations Endpoints
This is where things get technical. To get this custom integration setup, you will need developer access and an understanding of code. Note that we can't build this for you, but if your technical team has any questions, they can log a ticket for support here.
Creates an invitation for the user. Uses x-api-key HTTP header for authentication.
POST: https://app.betterbunch.com/openapi/invitations
Check out how to find your Open API Key here.
HTTP HEADERS
x-api-key
string Required72413c419f5312dd2defcd837fb4c3703a
JSON PARAMETERS
name
string Optional
scott
string Optional
scott@gmail.com
phoneNumber
string Optional
+6425555639
sendDate
Datetime to send the invitation in the timezone of the account Optional
2023-08-29T02:16:54
sendFollowUp
Determines whether a promoter retargeting email should be sent (boolean) Optional. If not provided, account settings are used.
false
ignoreCoolOffPeriod
Determines whether the cool of period setting should be ignored (boolean) Optional. Default: false.
false
RESPONSES
201 Json with id of the created invitation. 200, when an invitation was not created, the reason would be provided in the json response. 500, when an unexpected error happens. 401, when not authorized.
Once connected, we encourage you to send a test invitation to ensure things run smoothly. You may choose to utilise logs to check that the communication is live.
Contact us here if you have questions or need a hand getting connected. We know this can be a little technical.