UniConnect Webhook API

Overview

The UniConnect Webhook API allows you to create and use webhooks for triggering automations and workflows within the UniConnect platform. Webhooks enable external systems to send real-time data into UniConnect using HTTP requests.

---

1. Creating a Webhook

Follow the steps below to configure and generate a webhook:

Enter Basic Details

• Provide a Name for the webhook.
• Add a Description to explain its purpose.

These fields help identify and manage webhooks within the system.

---

Configure URL Parameters

If your webhook requires dynamic values in the URL, define them as path parameters or query parameters.

Example:

https://api.uniconnect.com/webhook/{userId}?type={eventType}

Add JSON Payload

Define the request body in JSON format if your webhook requires structured data.

Example:

{
  "name": "John Doe",
  "phone": "+947XXXXXXXX",
  "message": "Test message"
}

info

This step is optional but required if no URL parameters are defined.

Sync Configuration

Click the Sync button after configuring parameters and/or JSON payload.

note

The Create Webhook option will only be enabled after syncing. You must define at least one of the following: URL Parameters, OR JSON Payload

Create and Copy Webhook URL

Once the webhook is created:

• Switch to Copiable Mode
• Copy the generated webhook URL

note

This URL will be used by external systems to trigger the webhook.

Supported HTTP Methods

The generated webhook URL supports the following request methods:

• POST – For sending data via request body (JSON)
• GET – For simple requests using URL parameters

Using Webhooks in Automations

After creation, the webhook becomes available within the UniConnect automation module.

Automations / Workflows → Trigger → Webhook Module

2. Example Use Case

SMS Send (Test Automation)

1. Create a webhook with required fields (e.g., phone number, message).
2. Integrate the webhook into a workflow.
3. Trigger the webhook via an API call.
4. Automation executes and sends SMS.

3. Best Practices

• Use clear naming conventions for easier management.
• Validate JSON payloads before syncing.
• Secure webhook URLs when exposing them externally.
• Test using tools like Postman before production use.

4. Troubleshooting

Issue	Possible Cause	Solution
Create Webhook button disabled	No parameters or JSON defined	Add at least one and click Sync
Webhook not triggering automation	Not linked to workflow	Ensure webhook is selected in automation trigger
Invalid request error	Incorrect payload format	Validate JSON structure