The new webhooks Connector Module

Introduction

Hello everyone!

Today we want to announce a new version of the webhooks Connector Module.

The old version of the Module had many limitations that we could only address with a complete rewrite. To be backwards compatible the old version of the Module is still available under the name webhooks. The new Module can be configured under the name webhooksV2. If you don’t want to use the new Module it doesn’t require further actions.

We still recommend to switch to the new Module as soon as possible as the old Module is now deprecated and will not be maintained anymore.

The new Module

The new Module gives you the possibility to define so called triggers, which represent the names of the events we already send Connector-internally (e.g. transport.messageReceived). The Module then listens to the configured events and simply sends the event data to the configured URL. For a detailed documentation of how to configure the new webhooks Module, see the Connector configuration docs.

While in the old Module you could configure an interval in which the new information is published, the new Module calls the webhook immediately after the configured event was triggered. Do you miss the possibility to configure a publish interval? Raise a feature request in our feedback repository, and we will see what we can do about it.

Since you can use arbitrary events as triggers now, the new Module gives you much more points at which you can integrate. We provide a list of these events. Note that the list will grow in the next weeks, so check the docs from time to time. If you wish for a specific event, you can also raise a feature request.

Migration

In order to be notified about the same stuff as with the old Module, you should configure the new Module in the following way:

{
    "webhooksV2": {
        "targets": {
            "target1":  {
                "url": "https://example.com/webhook",
            }
        }
        "webhooks": [
            {
                "triggers": ["transport.messageReceived", "transport.relationshipChanged"],
                "target": "target1"
            }
        ]
    }
}

The data sent to the given URL has changed though:

{
    "trigger": string,
    "data": {
        // properties depend on the event
    }
}

In the POST body you will receive the trigger of the webhook (which is the name of the event), as well as the data of the event. Both are documented in the Connector Events section.