Features
The current release, called the V4 Engine is the new version of the TeamForge Webhooks-based Event Broker, delivered as part of TeamForge 19.3. It provides the following features:








Events
Events to be published through the TeamForge Webhooks-based Event Broker must be registered. Registering an event is required before you register the publisher or subscriber.
Examples of events include:
- Artifact create or Artifact update in TeamForge
- Build event in Jenkins
- Defect being filed in Jira, and so on
An event has the following key properties:
- a unique Event Name
- Content Type (Example: application/json)
- Event Type (TOPIC/QUEUE/SYNC)
- Event Format—This is a sample event that is used to understand the encoding and format of the message. JSON messages are validated. There is no message schema support.
Event Types
This table provides the supported event types—TOPIC, SYNC, and QUEUE.
Event Type | Description |
---|---|
TOPIC (Post-Submit) |
|
SYNC (Pre-Submit) |
|
QUEUE |
|
Publishers
Publishers publish events. In the case of the TeamForge Webhooks-based Event Broker, a Publisher can be equated to an application. Example: TeamForge, Ossum, JIRA, Jenkins, Nexus.
Subscribers
Subscribers subscribe to and receive messages. Subscribers in the TeamForge Webhooks-based Event Broker equated to applications. Example: TeamForge, Ossum, JIRA, Jenkins, Nexus.
Subscriptions
Each subscriber can have several subscriptions per event. Each subscription consists of the following critical properties:
- Subscriber
- Event Name
- Webhook Endpoint
- Subscription Filter. For more information on subscription filter, see Scripts and Filters in the TeamForge Webhooks-based Event Broker.
- For TOPIC subscriptions, a “Transform script” can be provided. For more information on transform script, see Scripts and Filters in the TeamForge Webhooks-based Event Broker.
- For SYNC subscriptions, if the response is embedded with the TeamForge Webhooks-based Event Broker using the “Internal JSVM” (internal JavaScript Virtual Machine), a response script can be provided. For more information on response script, see Scripts and Filters in the TeamForge Webhooks-based Event Broker.
TeamForge Integrations Using the TeamForge Webhooks-based Event Broker
TeamForge can be integrated with Jenkins, JIRA, TestLink, and Nexus using the TeamForge Webhooks-based Event Broker.
For more information, see:
Related Links
- Install the TeamForge Webhooks-based Event Broker
- TeamForge Webhooks-based Event Broker Settings
- TOPIC Event Type
- SYNC Event Type
- QUEUE Event Type
- Scripts and Filters in the TeamForge Webhooks-based Event Broker
[]: