Sign In
Sign Up

Webhook / Subscribe

Subscribe/ create webhook

Request Header Authorization
Authentication Yes

API Endpoint

{{ServerUrl}}api/v1/webhook/subscribe
POST

API Parameters

Request Parameter

Field DataType Required Description
webhookType string Yes webhook type
targetUrl string Yes target url

Response Parameter

Field DataType Description
status string response status
message string response message
payload
id bigint id
webhookName string webhook name
partnerId integer partner id
partnerName string partner name
webhookType string webhook type
targetUrl string target url
isActive boolean is active

Sample JSON Request:

				
					{
    "webhookType": "TRANS",
    "targetUrl": "https://webhook.site/0916c69c-7e2a-4b34-a9f3-a394d9724596"
}

Response Codes and Statuses

Status Code Error Description
000 Success

Error Codes

Status Code Error Description
101 General/Process error (see message)
301 Permission denined
401 Unauthorized
500 Internal server error (see message)

Sample JSON Responses: Success

				
					{
    "status": "000",
    "message": "Success",
    "payload": {
        "total": 1,
        "data": [
            {
                "id": 14,
                "webhookName": "Test",
                "partnerId": 1,
                "partnerName": "Partner 001",
                "webhookType": "TRANS",
                "targetUrl": "http://localhost",
                "isActive": true,
                "isDeleted": false,
                "createdOn": "2023-12-25T17:52:23.422005Z",
                "createdBy": 1,
                "createdByName": "System Admin",
                "modifiedOn": null,
                "modifiedBy": null,
                "modifiedByName": null
            }
        ]
    }
}

Change Log