The "Notify URL" is a webhook that can be used if you require a notification that a booking has been made back to a 3rd party. When a booking is complete, TryBooking will perform an HTTP GET request to your nominated URL.
Uses for this item could include a membership database that allows for one-off purchases or a system that manages responses to communication in a centralised database, where some require payments or when you have a list of "members" who can access the system for only 1 booking.
Each event can have it's own Notify URL. If you wish to have a default Notify URL that automatically applies to all events created, you can set the Notify URL at the account level.
Notify URL format
The notify URL should use the following format:
[Custom-Url]?sessionid=[sessionid]&customid=[cid]&amount=[transaction-amount]&tickets=[ticket-count]&bookingid=[booking-id]&status=[status]
Example: https://www.example.com?sessionid=[sessionid]&customid=[cid]&amount=[transaction-amount]&tickets=[ticket-count]&bookingid=[booking-id]&status=[status]
The "Notify URL" function will only work from the date/time of inserting the URL, and only for successful transactions. It will not populate back in time and will not work if the transaction is not successfully completed.
The fields on your notification URL include:
Parameter | Name | Value |
sessionid=[sid] | Session Id | The TryBooking Session ID |
cid=[YourCustomID] | Your Custom ID |
|
amount=[transaction-amount] | Amount | Transaction Value |
tickets=[ticket-count] | Ticket count | Ticket quantity purchased |
bookingid=[booking-id] | Booking GUID | The booking GUID (this is the unique booking ID to use on getTransaction API call) |
success=[success] | Success | Whether the booking was successful or not |
An API call can be made back to TryBooking for further transaction details if required.
Setting the Notify URL on an event
To set the Notify URL on an event:
From the left menu, click Dashboard
From the Manage events overview, click on your event name
From the left menu, select Event publication, under Event promotion
Select the Notify URL tab, and scroll down
Enter your Notify URL in the Notify URL field
Click Save
To ensure you Notify URL is working correctly you can use the Test button. It is also recommended you make a test booking.
Setting the Notify URL at the account level
Should you set the Notify URL at the account level, it will automatically apply to new events created. Once set it will automatically pull the Notify URL into the event.
To set the Notify URL at the account level:
From the left menu, click Dashboard
From the left menu, click Integration Tool, then select Notify URL
Enter your Notify URL in the Notify URL field
Click Save
To ensure you Notify URL is working correctly you can use the Test button.
Events created prior to this change will not have the Notify URL applied. For these events, you will need to set the Notify URL on the event itself.