Skip to content

Integration Webhooks

This is an older form of Webhook, which only supports events related to changes in integration state. Unlike General Webhooks, each event generates an individual Webhook.

Entity
Event
Description
IntegrationIntegrationCreatedEvent triggered when a new integration is created
IntegrationIntegrationEnabledEvent triggered when a integration is enabled
IntegrationIntegrationDisabledEvent triggered when a integration is disabled
IntegrationIntegrationCanceledEvent triggered when a integration is canceled
IntegrationIntegrationReinstatedEvent triggered when a integration is reinstated
IntegrationIntegrationDeletedEvent triggered when a integration is deleted

An Integration refers to the unique connection between an Enterprise or Property (i.e. Mews customer) and an API client (i.e. Mews partner), corresponding to a unique Access Token. For a full description of all the terms used, see the Mews Glossary for Open API users.

{
"Action": "IntegrationCreated",
"Data": {
"Enterprise": {
"Id": "8865aa96-f62d-4f9b-a912-ab2100f60f42",
"Name": "Sample Chain Hotel 1"
},
"Service": {
"Id": "9745ce3a-8dbb-4cc0-a550-55f9ff67b242",
"Name": "Accommodation"
},
"Requestor": null,
"AccessToken":"9E5E84E9974D4F169662AB2200F27CB1-00B343A0DDA725CACAC028E38E3EABF",
"CreatedUtc": "2019-12-13T14:42:52Z",
"IsEnabled": true,
"Integration": {
"Id": "9e5e84e9-974d-4f16-9662-ab2200f27cb1",
"Name": "WebhookTEST"
}
}
}
PropertyTypeContractDescription
Actionstring Webhook actionrequiredType of action or event.
DataobjectrequiredStructure of the object depends on Webhook action.

The structure of the Data object depends on Webhook action.

PropertyTypeContractDescription
EnterpriseEnterpriserequiredProperty or chain of properties.
ServiceServiceoptionalService the integration is connected to.
RequestorRequestorrequiredPerson requesting the action or event.
AccessTokenstringrequiredAccess token of the client application.
CreatedUtcstringrequiredCreation date and time of the integration in UTC timezone in ISO 8601 format.
IsEnabledboolrequiredWhether integration is enabled.
IntegrationIntegrationrequiredIntegration data.
PropertyTypeContractDescription
IdstringrequiredUnique identifier of the enterprise.
NamestringrequiredName of the enterprise.
PropertyTypeContractDescription
IdstringrequiredUnique identifier of the service.
NamestringrequiredName of the service.
PropertyTypeContractDescription
NamestringrequiredName of the requestor.
EmailstringrequiredEmail of the requestor.
PropertyTypeContractDescription
IdstringrequiredUnique identifier of the integration.
NamestringrequiredName of the integration.
PropertyTypeContractDescription
IntegrationIntegrationrequiredIntegration data.
PropertyTypeContractDescription
IntegrationIntegrationrequiredIntegration data.
PropertyTypeContractDescription
IntegrationIntegrationrequiredIntegration data.
PropertyTypeContractDescription
IntegrationIntegrationrequiredIntegration data.
PropertyTypeContractDescription
DeletedUtcstringrequiredDeletion date and time of the integration in UTC timezone in ISO 8601 format.
IntegrationIntegrationrequiredIntegration data.