Connector API
  • Mews Connector API
  • Getting started
  • Usage guidelines
    • Authentication
    • Requests
    • Responses
    • Environments
    • Serialization
    • Pagination
    • Best practices
  • Concepts
    • Multi-property
    • Restrictions
    • Taxation
    • Time units
  • Use cases
    • 'How to' use cases
    • Accounting
    • Customer loyalty
    • Customer management
    • Customer messaging
    • Data export
    • Device integration
    • Events
    • Guest technology
    • Housekeeping
    • Kiosk
    • Mews Payment Terminals
    • Payment automation
    • Point of sale
    • Reputation management
    • Revenue management
    • Upsell
  • API Operations
    • Common objects
    • Accounting categories
    • Accounting items
    • Accounts
    • Account notes
    • Addresses
    • Age categories
    • Availability adjustments
    • Availability blocks
    • Bills
    • Business segments
    • Cancellation policies
    • Cashiers
    • Cashier transactions
    • Commands
    • Companies
    • Companionships
    • Company contracts
    • Configuration
    • Counters
    • Countries
    • Credit cards
    • Currencies
    • Customers
    • Departments
    • Devices
    • Enterprises
    • Exchange rates
    • Exports
    • Identity documents
    • Images
    • Languages
    • Loyalty memberships
    • Loyalty programs
    • Loyalty tiers
    • Messages
    • Message threads
    • Order items
    • Orders
    • Outlet bills
    • Outlet items
    • Outlets
    • Payments
    • Payment requests
    • Preauthorizations
    • Product categories
    • Product service orders
    • Products
    • Rates
    • Rate groups
    • Reservations
    • Reservation groups
    • Resource access tokens
    • Resource blocks
    • Resources
    • Resource categories
    • Resource features
    • Restrictions
    • Routing rules
    • Rules
    • Service order notes
    • Service overbooking limits
    • Services
    • Source assignments
    • Sources
    • Tasks
    • Tax environments
    • Taxations
    • Vouchers
    • Voucher codes
  • API Events
    • Ways to communicate
    • General Webhooks
    • Integration Webhooks
    • Webhooks FAQ
    • WebSockets
  • Your integration journey
    • Certification
  • Deprecations
    • Migration guide: Get all reservations
  • Changelog
    • Changelog 2024
    • Changelog 2023
    • Changelog 2022
    • Changelog 2021
    • Changelog 2020
    • Changelog 2019
    • Changelog 2018
    • Changelog 2017
    • Changelog 2016
Powered by GitBook
On this page
  • How do I register a Webhook with Mews?
  • Are there special considerations for setting up a Webhook server?
  • How can I authenticate Mews?
  • Figure 1: Webhook Authentication
  • How should the server respond to a Webhook request?
  • When should I use Webhooks?
  • How are Webhooks different to WebSockets?
  • What events can I create Webhooks for?
  • What does an event message look like?
  • What is the frequency of event generation?
  • Can I see what Webhooks are configured?
  • Can I set up multiple Webhooks?
  • Can I use Webhooks in an on-premise application?
  • Is it possible to disable sending some messages to Webhooks?
  • Can you give me a specific use case for Webhooks?
  • Is there a limit on the number of events in one Webhook?
  • I want an event not currently supported

Was this helpful?

  1. API Events

Webhooks FAQ

PreviousIntegration WebhooksNextWebSockets

Last updated 3 months ago

Was this helpful?

How do I register a Webhook with Mews?

Are there special considerations for setting up a Webhook server?

There are no special considerations for setting up a Webhook server. It simply needs to be an endpoint that is accessible to the Mews system and can receive and process incoming HTTP requests with JSON content-type. No special content-type headers are used.

How can I authenticate Mews?

To confirm that a request to your Webhook endpoint originates from Mews, we can add a shared secret token to the URL, as follows:

Figure 1: Webhook Authentication

How should the server respond to a Webhook request?

HTTP status codes should be returned as normal, e.g. you can use HTTP status code 200 or 202 to indicate success. You should send 400 codes and 500 codes as normal for different failure conditions. Note that if an event message fails to be delivered (either a timeout occurs or an HTTP error code is received), then the message will be re-sent after an interval delay, but after three failed attempts it will be abandoned.

When should I use Webhooks?

How are Webhooks different to WebSockets?

What events can I create Webhooks for?

See the Webhook reference pages for the list of currently supported events:

What does an event message look like?

See the Webhook reference pages for details of the request body:

What is the frequency of event generation?

Can I see what Webhooks are configured?

Can I set up multiple Webhooks?

Can I use Webhooks in an on-premise application?

Although possible, it is generally not recommended for on-premise solutions to use Webhooks, because we may update the API once or twice a year which may require updates to your application. In that case, if pushing the updates to the on-premise solution is difficult then the solution won't scale well.

Is it possible to disable sending some messages to Webhooks?

Can you give me a specific use case for Webhooks?

Is there a limit on the number of events in one Webhook?

I want an event not currently supported

Email with details of your Webhook endpoint URL.

To use this authentication, send us the token you wish to use via . The token should be kept secret and not shared with anyone except Mews.

See .

See .

The frequency at which events are created in the Mews system depends on the type of event and on the level of activity. Note however there may be a time lag of up to several minutes from when the event occurs to when the actual Webhook request is made. See .

Webhooks are set up in the system administration, please contact for information about what Webhooks are configured on the system for your application.

Only one endpoint URL for and one endpoint URL for can be set up per integration client, i.e. per partner application. If you wish, you can use the same endpoint URL for both types of Webhook.

Yes. Event messages are configured for each integration, please contact with your requirements and they can configure only the messages you want to receive.

A specific use case for Webhooks is described in , but Webhooks are relevant to many use cases and are discussed in the relevant section - see .

carry multiple events that have occurred at the same time. Yes, there is an upper limit on the number of messages carried, before rolling over to a new message. This number is a system parameter, currently in the order of hundreds, but Mews reserves the right to adjust this value for performance reasons.

The list of supported events is always under review and may be extended in future. If there is a system event that you are particularly interested in, please submit your request via the Mews . We can't provide any guarantees, but we are very interested to know what kind of features our customers and partners are requesting.

partnersuccess@mews.com
partnersuccess@mews.com
Ways to communicate
Ways to communicate
General Webhooks
Integration Webhooks
General Webhooks
Integration Webhooks
partnersuccess@mews.com
General Webhooks
Integration Webhooks
partnersuccess@mews.com
General Webhooks
Product Ideas Forum
What does an event message look like?
How do I register a Webhook with Mews?
Are there special considerations for setting up a Webhook server?
How can I authenticate Mews?
How should the server respond to a Webhook request?
When should I use Webhooks?
How are Webhooks different to WebSockets?
What events can I create Webhooks for?
What is the frequency of event generation?
Can I see what Webhooks are configured?
Can I set up multiple Webhooks?
Can I use Webhooks in an on-premise application?
Is it possible to disable sending some messages to Webhooks?
Can you give me a specific use case for Webhooks?
Is there a limit on the number of events in one Webhook?
I want an event not currently supported
Use cases
When are Webhooks generated?
Event management - Managing availability block inventory and pickup
Webhook authentication