Entities: Webhook Webhook

Sends an updated Entity to your server.

Request Body schema: application/json

The updated Entity

object
entityId
string

The Entity's ID

object
Array of objects
object

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "entityId": "string",
  • "primaryProfile": {
    },
  • "languageProfiles": [
    ],
  • "changedFields": {
    }
}

Menus: Webhook Webhook

Sends an updated Menu object to your server.

Request Body schema: application/json

The updated Menu

object
object

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "menu": {
    }
}

Bios: Webhook Webhook

Sends an updated Bios object to your server.

Request Body schema: application/json

The updated Bios

object
object

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "bios": {
    }
}

Products: Webhook Webhook

Sends an updated Product List object to your server.

Request Body schema: application/json

The updated Product list

object
object

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "products": {
    }
}

Events: Webhook Webhook

Sends an updated Events List (Calendar) object to your server.

Request Body schema: application/json

The updated Event list

object
object

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "events": {
    }
}

Suggestions: Webhook Webhook

Sends an updated Suggestion object to your server.

NOTE:

  • App must have Manage Suggestions: Read/Write permission to set up webhook.
Request Body schema: application/json

The updated Suggestion

object
object

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "suggestion": {