Webhooks (also known as a web callback or HTTP push API) allow external applications to receive information about events that have occurred within the Olo platform. They are a simple way for Olo to alert a third party that something has happened and provide information about that event in near real-time. Partners that utilize webhooks gain an efficient way to take action based on events without needing to query Olo's systems for changes. Typical use cases may resemble the following but by no means are a complete list of all that can be accomplished with webhooks and the data they unlock for you:
- Want to collect new users' email addresses for welcome emails, surveys, or marketing campaigns? Want to be alerted whenever a vendor goes offline?
- Want to collect metrics on how many cheeseburgers are ordered on Tuesdays?
- Want to collect order data as it happens for revenue reports?
- Webhooks provide order, menu, user, and vendor data as it changes, allowing you to power your brand's custom productivity integrations with Olo data.
How does this work with Olo?
Webhooks allow third parties to subscribe to certain events that occur in Olo’s system by providing an HTTPS endpoint that Olo will deliver event details via HTTP POST. For the recipient, webhooks are a way to receive valuable information when it happens.
Types of webhooks & how to sign up
For details on supported webhook events please reference the Developer Portal documentation or the Dev Tools/Self Service Webhooks in Dashboard. Enabling webhooks for developer partners can be completed via Dashboard by brand users with the correct permissions. It is important to note before connections can be established, the customer (brand) must enable via Dashboard the events that will be sent. For Developer Partners that would like more detail, Olo can provide access to the Developer Portal to review documentation, and the customer can activate the requested webhooks. Please contact us via the Help Center with further questions.