Symfony Profiler

{% 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 %}
<div class="card">
<div class="card-body flex-column p-5">
<div class="d-flex align-items-center h-lg-150px p-5 p-lg-15">
<div class="row">
<div class="col-md-12 pt-5 scroll-y mt-10">
<h1 class="fw-bold fs-4 fs-lg-1 text-gray-800 mb-3">Learn about webhooks and how events are triggered for your account</h1>
<div class="position-relative w-100 text-gray-800">
Webhooks allow you to automate custom backend actions in response to the transitions that happen in a order & payment flows.
</div>
<h1 class="fw-bold fs-4 fs-lg-1 text-gray-800 mb-3 mt-10">Events overview</h1>
<div class="position-relative w-100 text-gray-800">
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.
</div>
</div>
</div>
</div>
<div class="d-flex align-items-center p-lg-15">
<div class="row scroll-x">
<div class="row">
<h1 class="fw-bold fs-4 fs-lg-1 text-gray-800 mb-3">Example events</h1>
The following events that can be sent via webhook.
<ul class="nav nav-tabs nav-line-tabs mb-5 fs-6">
<li class="nav-item">
<a class="nav-link active" data-bs-toggle="tab" href="#opening_hour">Opening Hour</a>
</li>
<li class="nav-item">
<a class="nav-link" data-bs-toggle="tab" href="#category">Category</a>
</li>
</ul>
<div class="tab-content" id="webhookExampleTabs">
<div class="tab-pane fade show active" id="opening_hour" role="tabpanel">
<div class="highlight text-gray-700">
<div class="highlight-code">
<pre class="language-html" tabindex="0">
<code class="language-html">
{
"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,
}
}
</code>
</pre>
</div>
</div>
</div>
<div class="tab-pane fade" id="category" role="tabpanel">
<div class="highlight text-gray-700">
<div class="highlight-code">
<pre class="language-html" tabindex="0">
<code class="language-html">
{
"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,
}
}
</code>
</pre>
</div>
</div>
</div>
</div>
<h1 class="fw-bold fs-4 fs-lg-1 text-gray-800 mb-3 mt-10">Event object structure</h1>
<h2 class="fs-3 mt-10">object</h2>
The concerned object with this event. we currently managing the following objects:
<ul>
<li>Opening hour</li>
</ul>
<h2 class="fs-3 mt-10">created</h2>
The date and time when this event occured.
<h2 class="fs-3 mt-10">event</h2>
<div class="p-4 bg-light-primary">
{% include 'Doc/States/Sync/sync.html.twig' %}
</div>
<h2 class="fs-3 mt-10">data</h2>
The new data for this object.
</div>
</div>
</div>
</div>
</div>
{% endblock %}
{% block stylesheets %}
<link href="{{ asset('metronic/v8.1.5/plugins/custom/prismjs/prismjs.bundle.css') }}" rel="stylesheet" type="text/css" />
{% endblock %}

templates/Doc/Webhook/Events/events-sync.html.twig line 1