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.
The NotifyUrl will:
Timeout after 10 seconds of no response
Assume any timeout or non-successful status result is a failed message
Retry failed messages at least two times
Deliver messages at least once to your chosen url, to minimise duplicates please return a 200 OK status result within 10 seconds
Only work from the date/time of inserting the URL
Notify URL format
The notify URL format example: https://www.example.com?bookingid=[booking-id]&status=[status]
The fields on your notification URL include:
Parameter | Tag | Value Description |
Booking ID | [booking-id] | Unique ID for the booking, o use on getTransaction API call |
Event ID | [event-id] | The Event that the booking was made for, numeric id unique to each event |
Transaction Amount | [transaction-amount] | The value of that transaction |
Transaction Status | [status] | Will return 1 for 'Success' or '2' for 'Failed' |
Ticket Count | [ticket-count] | The number of tickets purchased |
Custom ID | [CUSTOMID] | A custom ID of your choosing. Optional, can be ignored if not required. |
Custom Tags
To use and create a Custom Id in your webhook's responses, your customers should book using the following url. TryBooking will use the value cid=[value] as your Custom Id.
TryBooking Bookings
Embedded Bookings
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.