Skip to content

Commit

Permalink
fix: do not show event introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
stnmtz committed Sep 27, 2023
1 parent a32ee33 commit 6954dbe
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ docs_integrate:
url: /integrate/access-the-connector
- title: "Integration example"
url: /integrate/integration-example
- title: "Event introduction"
url: /integrate/event-introduction
#- title: "Event introduction"
# url: /integrate/event-introduction
- title: "Use Cases"
url: /integrate/use-cases

Expand Down
2 changes: 1 addition & 1 deletion _docs_integrate/event-introduction.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
permalink: integrate/event-introduction
published: true
published: false
title: "Event introduction"
type: scenario
toc: true
Expand Down
4 changes: 2 additions & 2 deletions _includes/scenarios/operate/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ It is not recommended to use this Module for production scenarios.

- **webhooks** `default: []`

The webhooks that will be called. A webhook consists of one or more [Connector Events]({% link _docs_integrate/event-introduction.md %}) on which the webhook should be triggered, as well as a target to which the request should be sent. The target either is an inline definition of target as described above, or a name of a target defined in the `targets` object.
The webhooks that will be called. A webhook consists of one or more [Connector Events]({% link _docs_integrate/connector-events.md %}) on which the webhook should be triggered, as well as a target to which the request should be sent. The target either is an inline definition of target as described above, or a name of a target defined in the `targets` object.

<br>

Expand Down Expand Up @@ -404,7 +404,7 @@ It is not recommended to use this Module for production scenarios.
}
```

You can find type definitions of the event data in the [Connector Events]({% link _docs_integrate/event-introduction.md %}) section.
You can find type definitions of the event data in the [Connector Events]({% link _docs_integrate/connector-events.md %}) section.

## Troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion _includes/scenarios/operate/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ The `sync` Module regularly fetches changes from the Backbone (e.g. new Messages

With the REST API, pull mechanisms are supported. However, as there are many bidirectional scenarios within enmeshed, a push mechanism is favorable: the Connector is synchronizing its state with the Backbone and notifies the organization's backend services about changes.

For this, the Connector supports the configuration of webhooks which are called every time a specific [Connector Event]({% link _docs_integrate/event-introduction.md %}) is triggered (e.g. a new Message has been received => `transport.messageReceived`).
For this, the Connector supports the configuration of webhooks which are called every time a specific [Connector Event]({% link _docs_integrate/connector-events.md %}) is triggered (e.g. a new Message has been received => `transport.messageReceived`).

Keep in mind that you need to synchronize the state of the Connector with the Backbone in order to receive events. The `sync` Module automates this, but you can also do this manually by calling the `/api/v2/Account/Sync` route.
4 changes: 2 additions & 2 deletions _posts/2022-03-02-webhooks-v2-connector-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The new Module gives you the possibility to define so called `triggers`, which r
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](https://github.com/nmshd/feedback/issues/new/choose), 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]({% link _docs_integrate/event-introduction.md %}). 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](https://github.com/nmshd/feedback/issues/new/choose).
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]({% link _docs_integrate/connector-events.md %}). 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](https://github.com/nmshd/feedback/issues/new/choose).

## Migration

Expand Down Expand Up @@ -62,4 +62,4 @@ The data sent to the given URL has changed though:
}
```

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]({% link _docs_integrate/event-introduction.md %}) section.
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]({% link _docs_integrate/connector-events.md %}) section.

0 comments on commit 6954dbe

Please sign in to comment.