Passing data to other systems
There are a few different ways to send data from YCBM to other platforms.
This feature is available on All plans. In this article:
- Using Zapier
- Using outgoing webhooks in your notifications
- Validate your JSON formatting
- Send data to Zapier through Webhooks
- Using our API
Using Zapier
Zapier is a third-party tool that allows you to connect over 1,000 apps. This means you can easily transfer data from YCBM through to your CRM or email service provider. Check out our article here on integrating Zapier into your YCBM account.
Using Outgoing Webhooks
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.
Webhooks will fire off after a specific event has occurred i.e. a booking is made, rescheduled, or canceled.
💡Check out Zapier's post explaining webhooks.
There are three things needed for a webhook to work properly:
1. An endpoint URL
This is where you will be sending the data.
2. The request type
GET, PUT, POST, PATCH, DELETE
This tells the webhook what to do with the information.
3. Request Headers
Add a key value pair for any targer server to authorize the connection (advanced)
4. 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 the booking and pass it through your webhook.
The basic formatting will look like (in JSON):
{
"startDateTime": "{START-ISO}",
"endDateTime": "{END-ISO}",
"firstName": "{FNAME}",
"email": "{EMAIL}"
}
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.
- {ENCODE-FOR-URL}
- {ENCODE-FOR-JSON}
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 Additional options from the left menu.
- Click Notifications under the sub-menu.
- Click into the notification you wish to have the webhook fire (After new booking made, rescheduled, cancelled, reminder, after appointment ends, etc)
- 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
Validate your JSON formatting
Webhooks must be entered in a valid JSON format. If you see an error, you can use this site to make sure your JSON is formatted correctly.
Send data to Zapier through Webhooks
Review our Integrate Zapier with YCBM to get started!
YouCanBookMe API
API connections require a bit more programming to work correctly. Similar to a webhook you will use the same methods to send data from YCBM 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.
The YCBM Support Team can help with basic API questions but isn't trained in in-depth API troubleshooting. You may need to hire a developer to help you configure something using the API. If you're a developer who wants to build your integration with YCBM, check out our API documentation or the YCBM Forum
For further questions, contact our team at support@youcanbook.me.
Access your YCBM Dashboard