🧑💻Are you a developer?
A web developer usually sets up webhooks on behalf of a Toggle client. Check our developer's page for additional details.
How to create a webhook - GIF demo (no sound)
How do I create a webhook? (Written guide)
1 - Log into your Toggle account
2- From the sidebar click on Settings and then Webhooks
☝️Sidenote: If you're a developer without Toggle access, ask your client to complete these steps, or to add you as a user. Our guide has more info: How to add users to Toggle
3 - You will now see a screen like shown below.
Endpoint URL
4 - Enter your endpoint URL.
It must be an https:// URL.
This is the web address on your own system where Toggle sends event data, like when an order is created.
Events
5 - Tick the 'Events' you want your webhook to pull into your 3rd party platform.
(You need to enter an Endpoint URL first before you can tick anything).
About the Events Toggle can let you pull
Toggle's webhook has 14 events you can send to your 3rd party platform. Here's a summary of what they do:
Card balance adjusted | This event is triggered when a card balance changes such as when it's redeemed, expires, or is topped-up. |
Card expiry reminder | This event is triggered when the reminder email is sent. |
Card resend recipient email | This event is triggered when a gift card recipient email is resent. |
Fulfilment dispatched | This event is triggered when a postal order is marked as dispatched. |
Order created | This event is triggered when an order in Toggle is created (either by sending a free gift card on the dashboard or when someone buys a gift card on your Toggle shop). |
Order send receipt email | This event is triggered when an order receipt email is sent after a successful order is placed on the Toggle shop. |
Payment review opened | This event is triggered when a payment is flagged for review by the payment gateway (like Stripe). No order is created until the review is finished. |
Card reference updated | This event is triggered when a gift card's reference number is updated. |
Card registered | This event is triggered when a customer registers their gift card. |
Card send recipient email | This event is triggered when the gift email is sent to a recipient (after a successful order placed on the Toggle shop or after sending a free voucher on the Toggle dashboard). |
Order cancelled | This event is triggered when an order in Toggle is cancelled. |
Order send cancellation email | This event is triggered whenever an order cancellation email should be sent. |
Payment failed | This event is triggered when a payment that was in review (on your payment gateway) gets rejected. No order is created when this happens. |
Ticket send recipient email | Triggered when a ticket email is sent to a recipient, similar to the card recipient email event |
The 'Signing Secret'
After entering your Endpoint URL and ticking the event data you want to pull, click the green Save button in the top right of the page.
You will then see a new section appear on the page you're on, like this example:
⚠️ Before clicking off the page ⚠️
Remember to click the green Copy button (or manually highlight and copy the Signing secret) and save it somewhere secure, like your desktop or a password manager.
If you skip this and click away, you'll lose the Signing Secret and need to redo the steps above to get a new one.
After clicking off or refreshing the page, the Signing Secret will be blanked out - this just shows one exists, but you won't be able to see what it is.
How do I create a new Signing Secret?
Click the red 'Regenerate secret' button. This instantly invalidates the existing secret and generates a new one for you to copy and use.
How do I delete my webhook?
Go to Settings > Webhooks, delete the Endpoint URL, and press Save.
Other FAQs
What is a webhook?
A webhook is a way for one app to automatically tell another app "hey, something just happened" as soon as it happens.
For example, once a webhook is set up between your Toggle account and a 3rd party app, an event like an order being placed, along with its data, gets sent straight to that app.
Do I need to set up a webhook?
Most people won't need to set up a webhook on Toggle.
We already offer 'official' integrations with other tech platforms in hospitality and beyond. These are ready to use out the box, so you don't need a webhook to connect with them.
You can find all our official integrations by going to Settings > Integrations on the sidebar of your Toggle account. To find out more, head to our website here or find the set-up guides here.
If we don't officially integrate with a platform you want connected to Toggle, you'll need a bespoke set up using our webhooks.
NB: If you use Lightspeed, our integration with them does require a webhook, but that webhook set up via the Lightspeed tile found on Settings > Integrations > Lightspeed.
Can Toggle create an official integration so I don't need to use a webhook?
We're always on the lookout for more integrations. If we get enough demand for a platform, we'll push it higher up our to-do list.
Reach out to us at success@usetoggle.com if you have a platform you want us to integrate with, there's a chance we're already working on it, so you might not need a webhook at all.
Can I set up more than one webhook on my Toggle account?
You can only set up one webhook per Toggle account at a time.