Temporal Broadcaster Setup Guide

Introduction

This guide provides step-by-step instructions to configure the Temporal Broadcaster feature, allowing you to broadcast platform events to Temporal workflows.

Steps to Configure Temporal Broadcaster

Step 1: Accessing Temporal Broadcaster

To access the Temporal Broadcaster:

1. Log in to the Fynd Partner Panel.
2. Navigate to Extensions and select the desired extension.
3. Under the selected extension, click on Webhook.
4. Click on Add Configuration.
5. Select Temporal from the list of broadcaster types.
6. You will be directed to the Temporal Config page.

Step 2: Configuring Temporal Broadcaster

Enter the following details:

• Name: Provide a name for identification.
• Address: Enter the Temporal server address (e.g., temporal.example.com:7233).
• Namespace: Specify the Temporal namespace you wish to use.
• TLS Cert: Upload the TLS certificate file if required.
• TLS Key: Upload the corresponding TLS key file if required.

Explanation of Fields:

• Address: The network address of your Temporal server.
• Namespace: Logical grouping of workflows within Temporal.
• TLS Cert and TLS Key: For secure communication if TLS is enabled.

Step 3: Validation

1. Click on Validate.
2. The platform will attempt to establish a connection with the Temporal server using the provided details.
3. Upon successful validation, a confirmation message will appear.
4. Click on Save to complete the configuration.

A pop-up will appear indicating Validation Successful if the entered details are valid.

Step 4: Create Temporal Subscriber API

1curl --location 'https://{{host}}/service/platform/webhook/v2.0/company/1/subscriber' --header 'Content-Type: application/json' --header 'Authorization: {{Bearer Token}}' --data-raw '{
2    "name": "Temporal Subscriber",
3    "provider": "temporal",
4    "association": {
5        "company_id": 1,
6        "criteria": "ALL",
7        "extension_id":"6684c91938568e58638a2b42"
8    },
9    "custom_headers": {},
10    "status": "active",
11    "email_id": "[email protected]",
12    "auth_meta": {},
13    "events": [
14        {
15            "slug": "company/article/update/v1",
16            "queue": "fynd-json-company-article-temporal-event",
17            "workflow_name": "article-workflow"
18        }
19    ]
20}'