Create Webhook Configuration

POST

/api/v0/webhook-data

Webhook Data Apis

📌

Use this API to create and configure a webhook for your EnKash account.
By setting up a webhook, you enable EnKash to automatically send real-time notifications to your specified endpoint for events such as transaction status updates, payout completions, or balance changes.

Request

Body Params application/json

headers

object

optional

Additional properties

string

optional

webhookUrl

string

required

sslCertificate

string

optional

events

array[string]

required

Allowed values:

PAYOUT_SUCCESSPAYOUT_PENDINGPAYOUT_FAILEDUTILITY_BILLPAY_SUCCESSUTILITY_BILLPAY_FAILEDUTILITY_BILLPAY_PENDING

enabled

boolean

optional

companyId

string

optional

Match pattern:

^CEK[A-Z0-9]{7}$

Example

{
    "headers": {
        "property1": "string",
        "property2": "string"
    },
    "webhookUrl": "string",
    "sslCertificate": "string",
    "events": [
        "PAYOUT_SUCCESS"
    ],
    "enabled": true,
    "companyId": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://test.your-api-server.com/api/v0/webhook-data' \
--header 'Content-Type: application/json' \
--data-raw '{
    "headers": {
        "property1": "string",
        "property2": "string"
    },
    "webhookUrl": "string",
    "sslCertificate": "string",
    "events": [
        "PAYOUT_SUCCESS"
    ],
    "enabled": true,
    "companyId": "string"
}'

Responses

🟢200OK

*/*

Body

response_code

integer <int32>

optional

response_message

string

optional

payload

object (WebhookDataResponse)

optional

companyId

string

optional

headers

object

optional

webhookUrl

string

optional

sslCertificate

string

optional

events

array[string]

optional

Allowed values:

PAYOUT_SUCCESSPAYOUT_PENDINGPAYOUT_FAILEDUTILITY_BILLPAY_SUCCESSUTILITY_BILLPAY_FAILEDUTILITY_BILLPAY_PENDING

enabled

boolean

optional

Example

{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "companyId": "string",
        "headers": {
            "property1": "string",
            "property2": "string"
        },
        "webhookUrl": "string",
        "sslCertificate": "string",
        "events": [
            "PAYOUT_SUCCESS"
        ],
        "enabled": true
    }
}

Modified at 2025-07-08 19:05:55

Fetch Statement

Retrieve Webhook Data