mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-10-01 01:36:00 -04:00
3625f12abe
Creates a new organsied formatting system for webhook data, with interfaces for extending with custom model formatting rules. Allows easy usage & extension of the default bookstack formatting behaviour when customizing webhook events via theme system, and keeps default data customizations organised. This also makes the following webhook data changes: - owned_by/created_by/updated_by user details are loaded for events with Entity details. (POTENTIALLY BREAKING CHANGE). - current_revision details are loaded for page update/create events. Added testing to cover added model formatting rules. For #3279 and #3218
59 lines
1.9 KiB
PHP
59 lines
1.9 KiB
PHP
<div component="code-highlighter" class="card content-wrap auto-height">
|
|
<h2 class="list-heading">{{ trans('settings.webhooks_format_example') }}</h2>
|
|
<p>{{ trans('settings.webhooks_format_example_desc') }}</p>
|
|
<pre><code class="language-json">{
|
|
"event": "page_update",
|
|
"text": "Benny updated page \"My wonderful updated page\"",
|
|
"triggered_at": "2021-12-11T22:25:10.000000Z",
|
|
"triggered_by": {
|
|
"id": 1,
|
|
"name": "Benny",
|
|
"slug": "benny"
|
|
},
|
|
"triggered_by_profile_url": "https://bookstack.local/user/benny",
|
|
"webhook_id": 2,
|
|
"webhook_name": "My page update webhook",
|
|
"url": "https://bookstack.local/books/my-awesome-book/page/my-wonderful-updated-page",
|
|
"related_item": {
|
|
"id": 2432,
|
|
"book_id": 13,
|
|
"chapter_id": 554,
|
|
"name": "My wonderful updated page",
|
|
"slug": "my-wonderful-updated-page",
|
|
"priority": 2,
|
|
"created_at": "2021-12-11T21:53:24.000000Z",
|
|
"updated_at": "2021-12-11T22:25:10.000000Z",
|
|
"created_by": {
|
|
"id": 1,
|
|
"name": "Benny",
|
|
"slug": "benny"
|
|
},
|
|
"updated_by": {
|
|
"id": 1,
|
|
"name": "Benny",
|
|
"slug": "benny"
|
|
},
|
|
"draft": false,
|
|
"revision_count": 9,
|
|
"template": false,
|
|
"owned_by": {
|
|
"id": 1,
|
|
"name": "Benny",
|
|
"slug": "benny"
|
|
},
|
|
"current_revision": {
|
|
"id": 597,
|
|
"page_id": 2598,
|
|
"name": "My wonderful updated page",
|
|
"created_by": 1,
|
|
"created_at": "2021-12-11T21:53:24.000000Z",
|
|
"updated_at": "2021-12-11T21:53:24.000000Z",
|
|
"slug": "my-wonderful-updated-page",
|
|
"book_slug": "my-awesome-book",
|
|
"type": "version",
|
|
"summary": "Updated the title and fixed some spelling",
|
|
"revision_number": 2
|
|
}
|
|
}
|
|
}</code></pre>
|
|
</div> |