Webhook

Kafka broadcaster setup guide

This comprehensive guide will walk you through the detailed process of configuring and setting up the Kafka Broadcaster feature. This feature facilitates the seamless broadcasting of platform events on your Kafka topics.

To access the Kafka Broadcaster, follow these simple steps:

• Log in to the Fynd Partners Panel.
• Go to Extensions, and select any extension.
• Under the respective extension, click Webhook.
• In the Webhook section, go to Kafka Config located at the top-right corner.
• You will be directed to the Kafka Config.

Here, fill in the following details and click on Validate.

• Name: Provide a name for identification.
• Client ID: Enter a unique client ID.
• Host: Specify the host details. You can add multiple hosts by clicking "+ Add More". You can only add a maximum of three hosts.
• Connection Timeout: Set the connection timeout duration in ms (default: 1000 ms).
• Authentication Timeout: Define the authentication timeout in ms (default: 1000 ms).
• Request Timeout: Specify the request timeout in ms (default: 30000 ms).

• SSL Details: SSL (Secure Sockets Layer) is used for secure communication between the client and the Kafka broker. Three files are typically required for SSL configuration:
  • CA (Certificate Authority) file: Contains the public key of the CA that signed the broker's certificate.
  • Key file: This is the client's private key, which, along with the client certificate (CERT), is used for client authentication by the Kafka brokers.
  • CERT (Certificate file): This represents the client's public certificate in PEM format. It includes the client's public key and is presented to the Kafka brokers during the SSL/TLS handshake. The brokers use this certificate (and the CA certificates they trust) to authenticate the client.

• SASL Configuration: SASL is a framework for authentication and security in network protocols. In the context of Kafka, it's often used for secure authentication. SASL can be configured in three types:
  • PLAIN: This is a simple username/password-based mechanism.
  • AWS: SASL configuration can be adapted for authentication with AWS (Amazon Web Services) credentials.
  • OAuthBearer: SASL can be configured to use OAuthBearer tokens for authentication.

• Click Validate.
• Platform will validate the provided kafka information by establishing temporary connection.
• On successful validation, Click Save.
• Once registered and validated, partners gain access to the Kafka cluster configuration and authentication information. The specific name of the Kafka topic is obtained from the extension.

You can register events and topics in two different ways.

Approach 1: Using an API call

1curl --location '{{HOST}}/v2.0/company/1/subscriber' --header 'Content-Type: application/json' --data-raw '{
2"name": "Ginesys subscriber 2",
3"provider": "kafka",
4"association": {
5  "company_id": 1,
6  "criteria": "ALL",
7  "application_id": ["6369fc8124121b2008130d8a"]
8},
9"custom_headers": {},
10"status": "active",
11"email_id": "[email protected]",
12"auth_meta": {},
13"events": [
14  {
15    "slug": "application/courier-partner/assign/v1",
16    "topic":"fynd-json-broadcaster-cp-event"
17  },
18  {
19    "slug": "company/location/update/v1"
20  },
21  {
22    "slug": "company/company/update/v1"
23  }
24]
25}'

Approach 2: Using extension library

Refer here to learn how to register for webhook events using extension library.

Once the Kafka Broadcaster is validated on the Partner Panel, set up the Kafka-based event system, where events related to updating articles for a company trigger notifications or actions, and these events are consumed by subscribers. For example, upon accessing the CommonBroadcasterTopic, you will observe events like NewOrderReceived and PaymentProcessed. Implement your application logic to consume and respond to these events accordingly.