Using webhooks

            What are web hooks?

            Web hooks allow Quicket to send a message to another system when certain actions take place. The actions are called hooks. Quicket currently provides four hooks for your event:

            1. User started a check out
            2. Check out was cancelled
            3. User has booked to pay for their tickets by EFT
            4. Checkout completed (i.e. payment received)

            You may elect to use any or all of these hooks. If you have enabled a hook, Quicket will send a message when that hook is triggered.

            Web hooks can be used for a variety of purposes, including adding your event attendees automatically to a spreadsheet or CRM, sending out personalised messages to people who buy tickets, following up on dormant purchases and so on.

            How to activate web hooks:

            To use a hook, you need to supply Quicket with a listening URL for that hook. If you want to use multiple hooks, you can supply the same listening URL or different URL's for each hook. A listening URL is an internet address where a system will be ready to catch the message that Quicket sends out. Some CRM systems have got the ability to listen out for Quicket's web hooks. Alternatively, ask a developer to set up a listening URL for you that can listen out for the web hooks.

            Tip: if you don't have a CRM or a developer that can create a listening URL for you, try out a service like Zapier. Zapier is a service which allows you to create a listening URL, and then can perform actions when a message is received. (Find more general information on Zapier here, or click here for help setting up your Zapier integration.)

            1. To make use of the web hooks functionality, go to the web hooks page under the Integrate menu in your event dashboard
            2. On that page, provide a listening URL for each hook that you would like to use
            3. Make sure your listening URL is ready and waiting, and then click Send test.



            What information gets sent out?

            Quicket will send out a message when a specific hook is triggered. The information is written in a format called JSON format, which is a very common format that allows easy to parse data. The message contains information about the purchase, and about the tickets. This is a sample message:
            {
                    "reference":"REF00123456",
                    "event_id":123,
                    "event_name":"My Big Event",
                    "amount":0.00,
                    "email":"demo@example.com",
                    "event_date": "2015-02-18 17:15", //Start date of the event, if schedule will be the date of the schedule
                    "action":"checkout_started",
                            // options are "checkout_started","checkout_cancelled","eft_pending","checkout_completed"
                    "tickets":[
                                    {
                                        "id":122,
                                        "attendee_name":"",
                                        "attendee_email":"",
                                        "ticket_type":"Free Ticket",
                                        "price":0.00,
                                        "barcode": 12345678 //Barcode is 0 on checkout_started
                                    },
                                    {
                                        "id":122,
                                        "attendee_name":"",
                                        "attendee_email":"",
                                        "ticket_type":"Free Ticket",
                                        "price":0.00,
                                        "barcode": 12345678 //Barcode is 0 on checkout_started
                                    }
                                ]
                }

            Your listening URL will need to have the ability to parse (interpret) that data and act accordingly. If you choose to use Zapier, it can handle the information easily.

            Once you have put your listening URLs in, click Save changes. From that point onward, any time one of the hooks you have configured are triggered, Quicket will send out the information to you.

            Updated: 14 Jun 2017 06:25 AM
            Helpful?  
            Help us to make this article better
            0 0