Knowledge

The Webhooks submodule enables seamless integration by allowing users to create, configure, and manage webhooks. This includes functionality to set request methods, headers, and body parameters to meet various integration needs. Users can view all configured webhooks, activate or deactivate them, and perform actions such as editing or deleting a webhook.

Key Features:

1. Webhooks Listing Page:

• Displays all configured webhooks in a tabular format with the following columns: 

• Webhook Action Name: Unique name for the webhook.

• Request URL: The endpoint where webhook payloads are sent.

• Status: Indicates whether the webhook is Active or Inactive.

• Features: 

• Search Bar: Allows users to find specific webhooks.

• Pagination: Helps navigate through multiple webhook entries.

2. Add Webhook:

• Users can create a webhook by filling out the following fields: 

• Webhook Action Name: A descriptive name for the webhook action.

• Webhook For: Select the entity the webhook is tied to (e.g., Client, Admin, etc.).

• Request URL: Define the target URL where the webhook payload will be sent.

• Request Method: Select from the following options: 

• GET

• POST

• PUT

• PATCH

• DELETE

• Request Format: Choose between: 

• JSON

• XML

• Request Headers: 

• Add HTTP headers to the request. The options include common headers such as: 

• Accept

• Authorization

• Content-Type

• Cache-Control

• User-Agent

• Custom headers can also be added using the "custom" option.

• Request Body: 

• Define key-value pairs for the payload to be sent with the webhook. Useful for POST or PUT methods.

• Click Save

3. Webhook Status:

• Webhooks can have two statuses: 

• Active: Webhook is enabled and operational.

• Inactive: Webhook is disabled and will not send requests.

• Status can be toggled directly from the listing page.

4. Action Items:

• Edit: Modify webhook details such as headers, body, or target URL.

• Delete: Permanently remove the webhook.

FAQs:

1. What is the purpose of webhooks?

• Webhooks enable real-time communication between systems by sending HTTP requests to a specified URL when an event occurs.

2. How do I test a webhook after adding it?

• Testing functionality is not built into the Webhooks module. You can simulate the event and monitor the target endpoint or use tools like Postman to verify the webhook configuration.

3. Can I add custom headers to a webhook request?

• Yes, the "Request Headers" section allows you to add custom headers by selecting "custom" from the dropdown and providing the required name-value pair.

4. What request methods are supported?

• The following HTTP methods are supported: 

• GET, POST, PUT, PATCH, and DELETE.

5. Can I deactivate a webhook temporarily?

• Yes, you can set the webhook status to Inactive on the listing page to pause its operation.

6. What types of payloads can I send with webhooks?

• Webhooks support payloads in JSON or XML formats, as specified in the "Request Format" field during configuration.

For further assistance or to report an issue, please contact our support team.