API Events

API Events allow you to receive near-real-time notifications about key activities in the Mews system. These notifications are delivered via Webhooks or WebSockets, offering flexible solutions for various use cases. For an overview and guidance on selecting the best method for your needs, see Ways to communicate. To start using API Events, configure your system to receive event notifications and contact the Mews team at [e-mail] to register your Webhook or WebSocket.

Webhooks

Mews currently supports two types of Webhook: General Webhooks and Integration Webhooks. Both types of Webhook message are sent as HTTP POST requests with the event details in the JSON body, just like standard requests to API endpoints. For guidance on setting up a Webhooks server, registering the URL, and responding to Webhook messages, see our Webhooks FAQ.

Contents

• Ways to communicate – an explanation of API Operations, Webhooks and WebSockets

• General Webhooks – a single Webhook that consolidates multiple event types

• Integration Webhooks – individual Webhooks focused on integration state changes

• Webhooks FAQ – answers to common questions about Webhooks

• WebSockets – an alternative form of API Event for special use cases