Passing data to other systems
There are a few different ways to send data from YouCanBook.me to other platforms.
Zapier is a third party tool that allows you to connect over 1,000 apps. This means you can easily transfer data from YouCanBook.me through to your CRM or email service provider. Check out our article here on integrating Zapier to your YouCanBook.me account.
Webhooks are a convenient way to pass data from one application to another with minimal programming ability. Similar to the use of an API, webhooks have a protocol to either retrieve information, send information or delete it from a server.
YouCanBook.me can send webhook events that notify your application any time an event happens on your account.
Webhooks will fire off after a specific event has occurred i.e. a booking is made, rescheduled, or cancelled.
Essentially there are three things needed for a webhook to work properly:
- An endpoint URL.
- This is where you will be sending the data.
- The request type.
- GET, PUT, POST, PATCH, DELETE
- This tells the webhook what to do with the information.
- The payload
- This is the information that you will be passing through.
You will be able to fill in any shorthand code you have available to pull in information from your booking event and pass it through your webhook.
The basic formatting will look like (in JSON):
The formatting for this is important to ensure that accurate information is delivered. You will be able to pass through any information that is collected and you have a shorthand code to reference (even custom ones you create).
The endpoint URL is something that will be provided by the application or service you are passing this information into. Many companies will have documentation on how to use webhooks through their platforms, including the correct parameters you need to specify in the first " " set.
Encoding webhooks for special characters
Use encoding tags to preserve special characters passed through webhooks.
There are two tags to encode special characters, one for the webhook's URL and one for the webhook's payload.
These tags will allow special characters to appear correctly when passed through webhooks.
Setting up a webhook
Selecting the booking page you want to add a webhook, and click Edit Settings.
- Select Notifications from the left menu.
- Click Actions under the sub-menu.
- Click into the step you wish to have the webhook fire (Confirmation, Reschedule, Cancellation, Reminder)
- Click the + to add a new notification
- Click Webhook
- Enter URL
- Choose method
- GET - retrieves information about a resource.
- PUT - Creates a new resource
- POST - Changes an existing resource
- PATCH - Repairs a resource
- DELETE - deletes a resource
- Add payload
- Save changes
You can use Webhooks to send data into Zapier as well. A video overview: https://youcanbookme.wistia.com/medias/ez6bzaq6m8
API connections require a bit more programming to work correctly. Similar to a webhook you will use the same methods to send data from YouCanBook.me into other platforms and applications. The biggest difference between API and webhooks is that API will require authentication (typically an API key) to connect correctly. Also there will be specific URL destinations for making changes.
This is for the advanced YouCanBook.me user. Please view our public API here.
Our support for webhooks and API is limited as there are variables outside of our control, but you can reach out to firstname.lastname@example.org with any questions you may have.