{% extends 'Layouts/Doc/default.html.twig' %} {% block title %}{{ 'app.documentation.menu.webhook.events_order'|trans }}{% endblock %} {% block headerPageTitle %}WEBHOOK {{ 'app.documentation.menu.webhook.events_sync'|trans|upper }}{% endblock %} {% block body %}

Learn about webhooks and how events are triggered for your account

Webhooks allow you to automate custom backend actions in response to the transitions that happen in a order & payment flows.

Events overview

Events are our way of letting you know when something interesting happens in your account. When an event occurs, we create a new Event object. If you registered a webhook endpoint to receive that event, we send it to your endpoint as part of a POST request.

Example events

The following events that can be sent via webhook.


{
  "object": "{{ constant('App\\Entity\\Admin\\Webhook\\WebhookInterface::OBJECT_OPENING_HOUR') }}",
  "created": "2025-03-14T00:13:09+00:00",
  "event": "create", // {{ constant('App\\Entity\\Admin\\Webhook\\WebhookInterface::SYNC_EVENTS')|join(', ', ' and ') }}
  "param": [],
  "data": {
      "id": 363,
      "shop": {
          "id": "21",
          "name": "CHEZ GEGE",
      },
      "startingTime": "1970-01-01T12:00:00+00:00",
      "endingTime": "1970-01-01T13:00:00+00:00",
      "day": 6,
      "enabled": false,
      "startingTimeApi": 12:00:00,
      "endingTimeApi": 15:00:00,
    }
  }



{
  "object": "{{ constant('App\\Entity\\Admin\\Webhook\\WebhookInterface::OBJECT_CATEGORY') }}",
  "created": "2025-05-12T13:35:40+00:00",
  "event": "update", // {{ constant('App\\Entity\\Admin\\Webhook\\WebhookInterface::SYNC_EVENTS')|join(', ', ' and ') }}
  "param": [],
  "data": {
      "id": 1281,
      "imageFile": null,
      "parentId": null,
      "parent": null,
      "translations": {
          "name": "Boissons",
          "description": "Boissons",
          "locale": {
            "code": "fr_FR",
            "name": "Français",
          },
      },
      "visible": "false",
      "enabled": "false",
      "externalId": 6121212,
      "imageUrl": null,
      "position": 0,
    }
  }

Event object structure

object

The concerned object with this event. we currently managing the following objects:

  • Opening hour

created

The date and time when this event occured.

event

{% include 'Doc/States/Sync/sync.html.twig' %}

data

The new data for this object.

{% endblock %} {% block stylesheets %} {% endblock %}