Action Webhook

The“Webhook” process step in onOffice enables you to call up certain services automatically and in the background. Put simply, a webhook is a call to a specially prepared website that transmits targeted information without the need for constant polling.

These services work invisibly for the user in the background and are triggered by certain actions – for example, when fields of a property change during saving. You can use either Marketplace service-bound or freely configurable webhooks via GET or POST .

Context “Marketplace service bound”

This context allows the forwarding of information to a service of an onOffice Marketplace participant. This means that the webhook of the respective provider is triggered.

Examples:

• PriceHubble property valuation: If, for example, the price or area fields of a property change, the PriceHubble webhook can be triggered to initiate a new property valuation.
• Newsletter Connector: For the automated transfer of data to a newsletter service.

Requirements: The Marketplace service must be executed by the provider as a webhook and configured accordingly in its service.

Service / Parameters

Here you will find all Marketplace services activated in your client that contain a webhook. Select the desired service and, if necessary, enter parameter values that are transferred to the URL when the webhook is called. The possible parameters are determined by the respective provider.

Expert information

Webhooks are ideal for using the services of a marketplace provider as part of a process – for example when making changes to a property – e.g. to recalculate the market value.

If you have any questions about the individual webhooks, please refer to the documentation of the provider concerned or contact the provider of the Marketplace service directly. If you have any questions about the “Webhook” process step itself, please contact onOffice support (support@onoffice.de / +49 241 44 686 122).

Context “freely configurable” – GET

You can enter a webhook URL in the context of “freely configurable” type GET; when the process step is executed, the specified URL is called up in the background.

You can append further information to the URL with certain macros . To do this, add the desired values to the end of the URL using “?” and then “&”:

For example: https://meineurl.de?meinlabel1=_makro1&meinlabel2=_makro2

“meinlabel” is an example of the name of the corresponding field within the target system.

Note: only macros for which the process step has a context are resolved. These are mainly macros of the categories property, contacts, users, region group, company-specific and other general categories such as CI values.

Timeout: define the maximum waiting time for a response from the target server in the “Timeout in seconds” field (1-999). The default setting is 30 seconds.

Context “freely configurable” – POST

In addition to the GET method, the process manager supports POSTrequests to send structured payloads in the body of the request.

Basic configuration and timeout

In the process step, select the context “Freely configurable” and the type POST. After entering the destination URL , you can set the maximum waiting time for a response from the destination server if required in the “Timeout in seconds” field (1-999). If this limit is exceeded, the request is canceled and the process step is marked as incorrect.

Header configuration

The system sends the headers Content-Type: application/json and Content-Lengthby default. The value for Content-Length is only determined at runtime, as the resolution of macros influences the actual length of the payload.

To add further parameters (e.g. for authentication via Authorization), click on the pencil icon next to the header display. User-defined key-value pairs can be created in the lightbox that opens.

Definition of the payload (body)

The Webhook Body field defines the content of the request in JSON format. Here, onOffice macros can be used, which are replaced at runtime by the specific data of the linked data set. The body is limited by the system to a maximum length of 4096 characters . Content that exceeds this length (including resolved macros) is truncated when it is sent.

Fault diagnosis

If a webhook fails (e.g. due to a timeout or HTTP status codes 4xx/5xx), this is indicated in the process list by a red warning symbol (triangle). The details of the error and the server response can be viewed by mouseover over this icon.