mirrors/nextcloud-documentation
3
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2025-10-26 11:18:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #12801 from nextcloud/feat/webhook-calendar-obj-event

Browse Source 
feat: add schemas for new calendar object webhook events
This commit is contained in:
Edward Ly 2025-03-17 10:12:06 -07:00 committed by GitHub
commit 99d4e19cb1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 252 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

252
admin_manual/webhook_listeners/index.rst
View File

@ -209,6 +209,258 @@ This is an exhaustive list of available events. It features the event ID and the
}
}
* OCP\\Calendar\\Events\\CalendarObjectCreatedEvent
.. code-block:: text
array{
"user": array {"uid": string, "displayName": string},
"time": int,
"event": array{
"calendarId": int,
"calendarData": array{
"id": int,
"uri": string,
"{http://calendarserver.org/ns/}getctag": string,
"{http://sabredav.org/ns}sync-token": int,
"{urn:ietf:params:xml:ns:caldav}supported-calendar-component-set": 'Sabre\CalDAV\Xml\Property\SupportedCalendarComponentSet',
"{urn:ietf:params:xml:ns:caldav}schedule-calendar-transp": 'Sabre\CalDAV\Xml\Property\ScheduleCalendarTransp'
"{urn:ietf:params:xml:ns:caldav}calendar-timezone": string|null
},
"shares": list<array{
"href": string,
"commonName": string,
"status": int,
"readOnly": bool,
"{http://owncloud.org/ns}principal": string,
"{http://owncloud.org/ns}group-share": bool
}>,
"objectData": array{
"id": int,
"uri": string,
"lastmodified": int,
"etag": string,
"calendarid": int,
"size": int,
"component": string|null,
"classification": int
}
}
}
* OCP\\Calendar\\Events\\CalendarObjectDeletedEvent
.. code-block:: text
array{
"user": array {"uid": string, "displayName": string},
"time": int,
"event": array{
"calendarId": int,
"calendarData": array{
"id": int,
"uri": string,
"{http://calendarserver.org/ns/}getctag": string,
"{http://sabredav.org/ns}sync-token": int,
"{urn:ietf:params:xml:ns:caldav}supported-calendar-component-set": 'Sabre\CalDAV\Xml\Property\SupportedCalendarComponentSet',
"{urn:ietf:params:xml:ns:caldav}schedule-calendar-transp": 'Sabre\CalDAV\Xml\Property\ScheduleCalendarTransp'
"{urn:ietf:params:xml:ns:caldav}calendar-timezone": string|null
},
"shares": list<array{
"href": string,
"commonName": string,
"status": int,
"readOnly": bool,
"{http://owncloud.org/ns}principal": string,
"{http://owncloud.org/ns}group-share": bool
}>,
"objectData": array{
"id": int,
"uri": string,
"lastmodified": int,
"etag": string,
"calendarid": int,
"size": int,
"component": string|null,
"classification": int
}
}
}
* OCP\\Calendar\\Events\\CalendarObjectMovedEvent
.. code-block:: text
array{
"user": array {"uid": string, "displayName": string},
"time": int,
"event": array{
"sourceCalendarId": int,
"sourceCalendarData": array{
"id": int,
"uri": string,
"{http://calendarserver.org/ns/}getctag": string,
"{http://sabredav.org/ns}sync-token": int,
"{urn:ietf:params:xml:ns:caldav}supported-calendar-component-set": 'Sabre\CalDAV\Xml\Property\SupportedCalendarComponentSet',
"{urn:ietf:params:xml:ns:caldav}schedule-calendar-transp": 'Sabre\CalDAV\Xml\Property\ScheduleCalendarTransp'
"{urn:ietf:params:xml:ns:caldav}calendar-timezone": string|null
},
"targetCalendarId": int,
"targetCalendarData": array{
"id": int,
"uri": string,
"{http://calendarserver.org/ns/}getctag": string,
"{http://sabredav.org/ns}sync-token": int,
"{urn:ietf:params:xml:ns:caldav}supported-calendar-component-set": 'Sabre\CalDAV\Xml\Property\SupportedCalendarComponentSet',
"{urn:ietf:params:xml:ns:caldav}schedule-calendar-transp": 'Sabre\CalDAV\Xml\Property\ScheduleCalendarTransp'
"{urn:ietf:params:xml:ns:caldav}calendar-timezone": string|null
},
"sourceShares": list<array{
"href": string,
"commonName": string,
"status": int,
"readOnly": bool,
"{http://owncloud.org/ns}principal": string,
"{http://owncloud.org/ns}group-share": bool
}>,
"targetShares": list<array{
"href": string,
"commonName": string,
"status": int,
"readOnly": bool,
"{http://owncloud.org/ns}principal": string,
"{http://owncloud.org/ns}group-share": bool
}>,
"objectData": array{
"id": int,
"uri": string,
"lastmodified": int,
"etag": string,
"calendarid": int,
"size": int,
"component": string|null,
"classification": int
}
}
}
* OCP\\Calendar\\Events\\CalendarObjectMovedToTrashEvent
.. code-block:: text
array{
"user": array {"uid": string, "displayName": string},
"time": int,
"event": array{
"calendarId": int,
"calendarData": array{
"id": int,
"uri": string,
"{http://calendarserver.org/ns/}getctag": string,
"{http://sabredav.org/ns}sync-token": int,
"{urn:ietf:params:xml:ns:caldav}supported-calendar-component-set": 'Sabre\CalDAV\Xml\Property\SupportedCalendarComponentSet',
"{urn:ietf:params:xml:ns:caldav}schedule-calendar-transp": 'Sabre\CalDAV\Xml\Property\ScheduleCalendarTransp'
"{urn:ietf:params:xml:ns:caldav}calendar-timezone": string|null
},
"shares": list<array{
"href": string,
"commonName": string,
"status": int,
"readOnly": bool,
"{http://owncloud.org/ns}principal": string,
"{http://owncloud.org/ns}group-share": bool
}>,
"objectData": array{
"id": int,
"uri": string,
"lastmodified": int,
"etag": string,
"calendarid": int,
"size": int,
"component": string|null,
"classification": int
}
}
}
* OCP\\Calendar\\Events\\CalendarObjectRestoredEvent
.. code-block:: text
array{
"user": array {"uid": string, "displayName": string},
"time": int,
"event": array{
"calendarId": int,
"calendarData": array{
"id": int,
"uri": string,
"{http://calendarserver.org/ns/}getctag": string,
"{http://sabredav.org/ns}sync-token": int,
"{urn:ietf:params:xml:ns:caldav}supported-calendar-component-set": 'Sabre\CalDAV\Xml\Property\SupportedCalendarComponentSet',
"{urn:ietf:params:xml:ns:caldav}schedule-calendar-transp": 'Sabre\CalDAV\Xml\Property\ScheduleCalendarTransp'
"{urn:ietf:params:xml:ns:caldav}calendar-timezone": string|null
},
"shares": list<array{
"href": string,
"commonName": string,
"status": int,
"readOnly": bool,
"{http://owncloud.org/ns}principal": string,
"{http://owncloud.org/ns}group-share": bool
}>,
"objectData": array{
"id": int,
"uri": string,
"lastmodified": int,
"etag": string,
"calendarid": int,
"size": int,
"component": string|null,
"classification": int
}
}
}
* OCP\\Calendar\\Events\\CalendarObjectUpdatedEvent
.. code-block:: text
array{
"user": array {"uid": string, "displayName": string},
"time": int,
"event": array{
"calendarId": int,
"calendarData": array{
"id": int,
"uri": string,
"{http://calendarserver.org/ns/}getctag": string,
"{http://sabredav.org/ns}sync-token": int,
"{urn:ietf:params:xml:ns:caldav}supported-calendar-component-set": 'Sabre\CalDAV\Xml\Property\SupportedCalendarComponentSet',
"{urn:ietf:params:xml:ns:caldav}schedule-calendar-transp": 'Sabre\CalDAV\Xml\Property\ScheduleCalendarTransp'
"{urn:ietf:params:xml:ns:caldav}calendar-timezone": string|null
},
"shares": list<array{
"href": string,
"commonName": string,
"status": int,
"readOnly": bool,
"{http://owncloud.org/ns}principal": string,
"{http://owncloud.org/ns}group-share": bool
}>,
"objectData": array{
"id": int,
"uri": string,
"lastmodified": int,
"etag": string,
"calendarid": int,
"size": int,
"component": string|null,
"classification": int
}
}
}
* OCP\\Files\\Events\\Node\\BeforeNodeCreatedEvent
.. code-block:: text